AWS Interface¶

A standardised interface for interacting with AWS.

Provides simpler methods for CloudWanderer to call.

class CloudWandererAWSInterface(boto3_session=None, service_loader=None, service_mapping_loader=None)¶

Simplifies lookup of Boto3 services and resources.

__init__(boto3_session=None, service_loader=None, service_mapping_loader=None)¶

Simplifies lookup of Boto3 services and resources.

Parameters

boto3_session (boto3.session.Session) – A Boto3 session, if not provided the default will be used.
service_loader (Optional[cloudwanderer.boto3_loaders.MergedServiceLoader]) – An optional loader to allow the injection of additional custom services
service_mapping_loader (Optional[cloudwanderer.boto3_loaders.ServiceMappingLoader]) – An optional loader to allow the injection of additional custom service mappings

Return type

None

cleanup_resources(storage_connector, urns_to_keep=None, regions=None, service_names=None, resource_types=None, exclude_resources=None)¶

Delete records as appropriate from a storage connector based on the supplied arguments.

All arguments except storage_connector are optional.

Parameters

storage_connector (BaseStorageConnector) – The storage connector to delete the records from.
urns_to_keep (List[URN]) – A list of URNs which should not be removed from the storage_connector
regions (list) – The name of the region to get resources from (defaults to session default if not specified)
service_names (str) – The names of the services to write resources for (e.g. ['ec2'])
resource_types (list) – A list of resource types to include (e.g. ['instance'])
exclude_resources (list) – A list of service:resources to exclude (e.g. ['ec2:instance'])

Return type

None

get_resource(urn)¶

Return CloudWandererResource picked out by this urn.

Parameters: urn (URN) – The urn of the resource to get.
Return type: cloudwanderer.cloud_wanderer_resource.CloudWandererResource

get_resources(regions=None, service_names=None, resource_types=None, exclude_resources=None, **kwargs)¶

Get resources matching the arguments.

All arguments are optional.

Parameters

regions (list) – The name of the region to get resources from (defaults to session default if not specified)
service_names (str) – The names of the services to write resources for (e.g. ['ec2'])
resource_types (list) – A list of resource types to include (e.g. ['instance'])
exclude_resources (list) – A list of service:resources to exclude (e.g. ['ec2:instance'])
kwargs – All additional keyword arguments will be passed down to the Boto3 client calls.

Return type

Iterator[cloudwanderer.cloud_wanderer_resource.CloudWandererResource]