EC2¶

class ec2.classic_address¶

Example:

resources = storage_connector.read_resources(
    service="ec2",
    resource_type="classic_address")
for resource in resources:
    resource.load()
    print(resource.urn)
    print(resource.allocation_id)
    print(resource.association_id)
    print(resource.carrier_ip)
    print(resource.customer_owned_ip)
    print(resource.customer_owned_ipv4_pool)
    print(resource.domain)
    print(resource.instance_id)
    print(resource.network_border_group)
    print(resource.network_interface_id)
    print(resource.network_interface_owner_id)
    print(resource.private_ip_address)
    print(resource.public_ipv4_pool)
    print(resource.tags)

allocation_id¶: The ID representing the allocation of the address for use with EC2-VPC.

association_id¶: The ID representing the association of the address with an instance in a VPC.

carrier_ip¶: The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance).

customer_owned_ip¶: The customer-owned IP address.

customer_owned_ipv4_pool¶: The ID of the customer-owned address pool.

domain¶: Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard ) or instances in a VPC (vpc ).

instance_id¶: The ID of the instance that the address is associated with (if any).

network_border_group¶: The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.

network_interface_id¶: The ID of the network interface.

network_interface_owner_id¶: The ID of the AWS account that owns the network interface.

private_ip_address¶: The private IP address associated with the Elastic IP address.

public_ipv4_pool¶: The ID of an address pool.

tags¶: Any tags assigned to the Elastic IP address.

class ec2.dhcp_options¶

Example:

resources = storage_connector.read_resources(
    service="ec2",
    resource_type="dhcp_options")
for resource in resources:
    resource.load()
    print(resource.urn)
    print(resource.dhcp_configurations)
    print(resource.dhcp_options_id)
    print(resource.owner_id)
    print(resource.tags)

dhcp_configurations¶: One or more DHCP options in the set.

dhcp_options_id¶: The ID of the set of DHCP options.

owner_id¶: The ID of the AWS account that owns the DHCP options set.

tags¶: Any tags assigned to the DHCP options set.

class ec2.elastic_ip¶

Example:

resources = storage_connector.read_resources(
    service="ec2",
    resource_type="elastic_ip")
for resource in resources:
    resource.load()
    print(resource.urn)
    print(resource.allocation_id)
    print(resource.association_id)
    print(resource.carrier_ip)
    print(resource.customer_owned_ip)
    print(resource.customer_owned_ipv4_pool)
    print(resource.domain)
    print(resource.instance_id)
    print(resource.network_border_group)
    print(resource.network_interface_id)
    print(resource.network_interface_owner_id)
    print(resource.private_ip_address)
    print(resource.public_ip)
    print(resource.public_ipv4_pool)
    print(resource.tags)

allocation_id¶: The ID representing the allocation of the address for use with EC2-VPC.

association_id¶: The ID representing the association of the address with an instance in a VPC.

carrier_ip¶: The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance).

customer_owned_ip¶: The customer-owned IP address.

customer_owned_ipv4_pool¶: The ID of the customer-owned address pool.

domain¶: Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard ) or instances in a VPC (vpc ).

instance_id¶: The ID of the instance that the address is associated with (if any).

network_border_group¶: The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.

network_interface_id¶: The ID of the network interface.

network_interface_owner_id¶: The ID of the AWS account that owns the network interface.

private_ip_address¶: The private IP address associated with the Elastic IP address.

public_ip¶: The Elastic IP address.

public_ipv4_pool¶: The ID of an address pool.

tags¶: Any tags assigned to the Elastic IP address.

class ec2.image¶

Example:

resources = storage_connector.read_resources(
    service="ec2",
    resource_type="image")
for resource in resources:
    resource.load()
    print(resource.urn)
    print(resource.architecture)
    print(resource.block_device_mappings)
    print(resource.boot_mode)
    print(resource.creation_date)
    print(resource.description)
    print(resource.ena_support)
    print(resource.hypervisor)
    print(resource.image_id)
    print(resource.image_location)
    print(resource.image_owner_alias)
    print(resource.image_type)
    print(resource.kernel_id)
    print(resource.name)
    print(resource.owner_id)
    print(resource.platform)
    print(resource.platform_details)
    print(resource.product_codes)
    print(resource.public)
    print(resource.ramdisk_id)
    print(resource.root_device_name)
    print(resource.root_device_type)
    print(resource.sriov_net_support)
    print(resource.state)
    print(resource.state_reason)
    print(resource.tags)
    print(resource.usage_operation)
    print(resource.virtualization_type)

architecture¶: The architecture of the image.

block_device_mappings¶: Any block device mapping entries.

boot_mode¶: The boot mode of the image. For more information, see Boot modes in the Amazon Elastic Compute Cloud User Guide .

creation_date¶: The date and time the image was created.

description¶: The description of the AMI that was provided during image creation.

ena_support¶: Specifies whether enhanced networking with ENA is enabled.

hypervisor¶: The hypervisor type of the image.

image_id¶: The ID of the AMI.

image_location¶: The location of the AMI.

image_owner_alias¶: The AWS account alias (for example, amazon , self ) or the AWS account ID of the AMI owner.

image_type¶: The type of image.

kernel_id¶: The kernel associated with the image, if any. Only applicable for machine images.

name¶: The name of the AMI that was provided during image creation.

owner_id¶: The AWS account ID of the image owner.

platform¶: This value is set to windows for Windows AMIs; otherwise, it is blank.

platform_details¶: The platform details associated with the billing code of the AMI. For more information, see Obtaining Billing Information in the Amazon Elastic Compute Cloud User Guide .

product_codes¶: Any product codes associated with the AMI.

public¶: Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

ramdisk_id¶: The RAM disk associated with the image, if any. Only applicable for machine images.

root_device_name¶: The device name of the root device volume (for example, /dev/sda1 ).

root_device_type¶: The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.

sriov_net_support¶: Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

state¶: The current state of the AMI. If the state is available , the image is successfully registered and can be used to launch an instance.

state_reason¶: The reason for the state change.

tags¶: Any tags assigned to the image.

usage_operation¶: The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. usageOperation corresponds to the lineitem/Operation column on your AWS Cost and Usage Report and in the AWS Price List API . For the list of UsageOperation codes, see Platform Details and Usage Operation Billing Codes in the Amazon Elastic Compute Cloud User Guide .

virtualization_type¶: The type of virtualization of the AMI.

class ec2.instance¶

Example:

resources = storage_connector.read_resources(
    service="ec2",
    resource_type="instance")
for resource in resources:
    resource.load()
    print(resource.urn)
    print(resource.ami_launch_index)
    print(resource.architecture)
    print(resource.block_device_mappings)
    print(resource.boot_mode)
    print(resource.capacity_reservation_id)
    print(resource.capacity_reservation_specification)
    print(resource.client_token)
    print(resource.cpu_options)
    print(resource.ebs_optimized)
    print(resource.elastic_gpu_associations)
    print(resource.elastic_inference_accelerator_associations)
    print(resource.ena_support)
    print(resource.enclave_options)
    print(resource.hibernation_options)
    print(resource.hypervisor)
    print(resource.iam_instance_profile)
    print(resource.image_id)
    print(resource.instance_id)
    print(resource.instance_lifecycle)
    print(resource.instance_type)
    print(resource.kernel_id)
    print(resource.key_name)
    print(resource.launch_time)
    print(resource.licenses)
    print(resource.metadata_options)
    print(resource.monitoring)
    print(resource.network_interfaces_attribute)
    print(resource.outpost_arn)
    print(resource.placement)
    print(resource.platform)
    print(resource.private_dns_name)
    print(resource.private_ip_address)
    print(resource.product_codes)
    print(resource.public_dns_name)
    print(resource.public_ip_address)
    print(resource.ramdisk_id)
    print(resource.root_device_name)
    print(resource.root_device_type)
    print(resource.security_groups)
    print(resource.source_dest_check)
    print(resource.spot_instance_request_id)
    print(resource.sriov_net_support)
    print(resource.state)
    print(resource.state_reason)
    print(resource.state_transition_reason)
    print(resource.subnet_id)
    print(resource.tags)
    print(resource.virtualization_type)
    print(resource.vpc_id)

ami_launch_index¶: The AMI launch index, which can be used to find this instance in the launch group.

architecture¶: The architecture of the image.

block_device_mappings¶: Any block device mapping entries for the instance.

boot_mode¶: The boot mode of the instance. For more information, see Boot modes in the Amazon EC2 User Guide .

capacity_reservation_id¶: The ID of the Capacity Reservation.

capacity_reservation_specification¶: Information about the Capacity Reservation targeting option.

client_token¶: The idempotency token you provided when you launched the instance, if applicable.

cpu_options¶: The CPU options for the instance.

ebs_optimized¶: Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn’t available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

elastic_gpu_associations¶: The Elastic GPU associated with the instance.

elastic_inference_accelerator_associations¶: The elastic inference accelerator associated with the instance.

ena_support¶: Specifies whether enhanced networking with ENA is enabled.

enclave_options¶: Indicates whether the instance is enabled for AWS Nitro Enclaves.

hibernation_options¶: Indicates whether the instance is enabled for hibernation.

hypervisor¶: The hypervisor type of the instance. The value xen is used for both Xen and Nitro hypervisors.

iam_instance_profile¶: The IAM instance profile associated with the instance, if applicable.

image_id¶: The ID of the AMI used to launch the instance.

instance_id¶: The ID of the instance.

instance_lifecycle¶: Indicates whether this is a Spot Instance or a Scheduled Instance.

instance_type¶: The instance type.

kernel_id¶: The kernel associated with this instance, if applicable.

key_name¶: The name of the key pair, if this instance was launched with an associated key pair.

launch_time¶: The time the instance was launched.

licenses¶: The license configurations.

metadata_options¶: The metadata options for the instance.

monitoring¶: The monitoring for the instance.

network_interfaces_attribute¶: [EC2-VPC] The network interfaces for the instance.

outpost_arn¶: The Amazon Resource Name (ARN) of the Outpost.

placement¶: The location where the instance launched, if applicable.

platform¶: The value is Windows for Windows instances; otherwise blank.

private_dns_name¶: (IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state. [EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you’ve enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.

private_ip_address¶: The private IPv4 address assigned to the instance.

product_codes¶: The product codes attached to this instance, if applicable.

public_dns_name¶: (IPv4 only) The public DNS name assigned to the instance. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you’ve enabled DNS hostnames for your VPC.

public_ip_address¶: The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable. A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.

ramdisk_id¶: The RAM disk associated with this instance, if applicable.

root_device_name¶: The device name of the root device volume (for example, /dev/sda1 ).

root_device_type¶: The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.

security_groups¶: The security groups for the instance.

source_dest_check¶: Indicates whether source/destination checking is enabled.

spot_instance_request_id¶: If the request is a Spot Instance request, the ID of the request.

sriov_net_support¶: Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

state¶: The current state of the instance.

state_reason¶: The reason for the most recent state transition.

state_transition_reason¶: The reason for the most recent state transition. This might be an empty string.

subnet_id¶: [EC2-VPC] The ID of the subnet in which the instance is running.

tags¶: Any tags assigned to the instance.

virtualization_type¶: The virtualization type of the instance.

vpc_id¶: [EC2-VPC] The ID of the VPC in which the instance is running.

class ec2.internet_gateway¶

Example:

resources = storage_connector.read_resources(
    service="ec2",
    resource_type="internet_gateway")
for resource in resources:
    resource.load()
    print(resource.urn)
    print(resource.attachments)
    print(resource.internet_gateway_id)
    print(resource.owner_id)
    print(resource.tags)

attachments¶: Any VPCs attached to the internet gateway.

internet_gateway_id¶: The ID of the internet gateway.

owner_id¶: The ID of the AWS account that owns the internet gateway.

tags¶: Any tags assigned to the internet gateway.

class ec2.key_pair_info¶

Example:

resources = storage_connector.read_resources(
    service="ec2",
    resource_type="key_pair_info")
for resource in resources:
    resource.load()
    print(resource.urn)
    print(resource.key_fingerprint)
    print(resource.key_name)
    print(resource.key_pair_id)
    print(resource.tags)

key_fingerprint¶: If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.

key_name¶: The name of the key pair.

key_pair_id¶: The ID of the key pair.

tags¶: Any tags applied to the key pair.

class ec2.network_acl¶

Example:

resources = storage_connector.read_resources(
    service="ec2",
    resource_type="network_acl")
for resource in resources:
    resource.load()
    print(resource.urn)
    print(resource.associations)
    print(resource.entries)
    print(resource.is_default)
    print(resource.network_acl_id)
    print(resource.owner_id)
    print(resource.tags)
    print(resource.vpc_id)

associations¶: Any associations between the network ACL and one or more subnets

entries¶: One or more entries (rules) in the network ACL.

is_default¶: Indicates whether this is the default network ACL for the VPC.

network_acl_id¶: The ID of the network ACL.

owner_id¶: The ID of the AWS account that owns the network ACL.

tags¶: Any tags assigned to the network ACL.

vpc_id¶: The ID of the VPC for the network ACL.

class ec2.network_interface¶

Example:

resources = storage_connector.read_resources(
    service="ec2",
    resource_type="network_interface")
for resource in resources:
    resource.load()
    print(resource.urn)
    print(resource.association_attribute)
    print(resource.attachment)
    print(resource.availability_zone)
    print(resource.description)
    print(resource.groups)
    print(resource.interface_type)
    print(resource.ipv6_addresses)
    print(resource.mac_address)
    print(resource.network_interface_id)
    print(resource.outpost_arn)
    print(resource.owner_id)
    print(resource.private_dns_name)
    print(resource.private_ip_address)
    print(resource.private_ip_addresses)
    print(resource.requester_id)
    print(resource.requester_managed)
    print(resource.source_dest_check)
    print(resource.status)
    print(resource.subnet_id)
    print(resource.tag_set)
    print(resource.vpc_id)

association_attribute¶: The association information for an Elastic IP address (IPv4) associated with the network interface.

attachment¶: The network interface attachment.

availability_zone¶: The Availability Zone.

description¶: A description.

groups¶: Any security groups for the network interface.

interface_type¶: The type of network interface.

ipv6_addresses¶: The IPv6 addresses associated with the network interface.

mac_address¶: The MAC address.

network_interface_id¶: The ID of the network interface.

outpost_arn¶: The Amazon Resource Name (ARN) of the Outpost.

owner_id¶: The AWS account ID of the owner of the network interface.

private_dns_name¶: The private DNS name.

private_ip_address¶: The IPv4 address of the network interface within the subnet.

private_ip_addresses¶: The private IPv4 addresses associated with the network interface.

requester_id¶: The alias or AWS account ID of the principal or service that created the network interface.

requester_managed¶: Indicates whether the network interface is being managed by AWS.

source_dest_check¶: Indicates whether source/destination checking is enabled.

status¶: The status of the network interface.

subnet_id¶: The ID of the subnet.

tag_set¶: Any tags assigned to the network interface.

vpc_id¶: The ID of the VPC.

class ec2.placement_group¶

Example:

resources = storage_connector.read_resources(
    service="ec2",
    resource_type="placement_group")
for resource in resources:
    resource.load()
    print(resource.urn)
    print(resource.group_id)
    print(resource.group_name)
    print(resource.partition_count)
    print(resource.state)
    print(resource.strategy)
    print(resource.tags)

group_id¶: The ID of the placement group.

group_name¶: The name of the placement group.

partition_count¶: The number of partitions. Valid only if strategy is set to partition .

state¶: The state of the placement group.

strategy¶: The placement strategy.

tags¶: Any tags applied to the placement group.

class ec2.route_table¶

Example:

resources = storage_connector.read_resources(
    service="ec2",
    resource_type="route_table")
for resource in resources:
    resource.load()
    print(resource.urn)
    print(resource.associations_attribute)
    print(resource.owner_id)
    print(resource.propagating_vgws)
    print(resource.route_table_id)
    print(resource.routes_attribute)
    print(resource.tags)
    print(resource.vpc_id)

associations_attribute¶: The associations between the route table and one or more subnets or a gateway.

owner_id¶: The ID of the AWS account that owns the route table.

propagating_vgws¶: Any virtual private gateway (VGW) propagating routes.

route_table_id¶: The ID of the route table.

routes_attribute¶: The routes in the route table.

tags¶: Any tags assigned to the route table.

vpc_id¶: The ID of the VPC.

class ec2.security_group¶

Example:

resources = storage_connector.read_resources(
    service="ec2",
    resource_type="security_group")
for resource in resources:
    resource.load()
    print(resource.urn)
    print(resource.description)
    print(resource.group_id)
    print(resource.group_name)
    print(resource.ip_permissions)
    print(resource.ip_permissions_egress)
    print(resource.owner_id)
    print(resource.tags)
    print(resource.vpc_id)

description¶: A description of the security group.

group_id¶: The ID of the security group.

group_name¶: The name of the security group.

ip_permissions¶: The inbound rules associated with the security group.

ip_permissions_egress¶: [VPC only] The outbound rules associated with the security group.

owner_id¶: The AWS account ID of the owner of the security group.

tags¶: Any tags assigned to the security group.

vpc_id¶: [VPC only] The ID of the VPC for the security group.

class ec2.snapshot¶

Example:

resources = storage_connector.read_resources(
    service="ec2",
    resource_type="snapshot")
for resource in resources:
    resource.load()
    print(resource.urn)
    print(resource.data_encryption_key_id)
    print(resource.description)
    print(resource.encrypted)
    print(resource.kms_key_id)
    print(resource.outpost_arn)
    print(resource.owner_alias)
    print(resource.owner_id)
    print(resource.progress)
    print(resource.snapshot_id)
    print(resource.start_time)
    print(resource.state)
    print(resource.state_message)
    print(resource.tags)
    print(resource.volume_id)
    print(resource.volume_size)

data_encryption_key_id¶: The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots .

description¶: The description for the snapshot.

encrypted¶: Indicates whether the snapshot is encrypted.

kms_key_id¶: The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.

outpost_arn¶: The ARN of the AWS Outpost on which the snapshot is stored. For more information, see EBS Local Snapshot on Outposts in the Amazon Elastic Compute Cloud User Guide .

owner_alias¶: The AWS owner alias, from an Amazon-maintained list (amazon ). This is not the user-configured AWS account alias set using the IAM console.

owner_id¶: The AWS account ID of the EBS snapshot owner.

progress¶: The progress of the snapshot, as a percentage.

snapshot_id¶: The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

start_time¶: The time stamp when the snapshot was initiated.

state¶: The snapshot state.

state_message¶: Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots .

tags¶: Any tags assigned to the snapshot.

volume_id¶: The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.

volume_size¶: The size of the volume, in GiB.

class ec2.subnet¶

Example:

resources = storage_connector.read_resources(
    service="ec2",
    resource_type="subnet")
for resource in resources:
    resource.load()
    print(resource.urn)
    print(resource.assign_ipv6_address_on_creation)
    print(resource.availability_zone)
    print(resource.availability_zone_id)
    print(resource.available_ip_address_count)
    print(resource.cidr_block)
    print(resource.customer_owned_ipv4_pool)
    print(resource.default_for_az)
    print(resource.ipv6_cidr_block_association_set)
    print(resource.map_customer_owned_ip_on_launch)
    print(resource.map_public_ip_on_launch)
    print(resource.outpost_arn)
    print(resource.owner_id)
    print(resource.state)
    print(resource.subnet_arn)
    print(resource.subnet_id)
    print(resource.tags)
    print(resource.vpc_id)

assign_ipv6_address_on_creation¶: Indicates whether a network interface created in this subnet (including a network interface created by RunInstances ) receives an IPv6 address.

availability_zone¶: The Availability Zone of the subnet.

availability_zone_id¶: The AZ ID of the subnet.

available_ip_address_count¶: The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.

cidr_block¶: The IPv4 CIDR block assigned to the subnet.

customer_owned_ipv4_pool¶: The customer-owned IPv4 address pool associated with the subnet.

default_for_az¶: Indicates whether this is the default subnet for the Availability Zone.

ipv6_cidr_block_association_set¶: Information about the IPv6 CIDR blocks associated with the subnet.

map_customer_owned_ip_on_launch¶: Indicates whether a network interface created in this subnet (including a network interface created by RunInstances ) receives a customer-owned IPv4 address.

map_public_ip_on_launch¶: Indicates whether instances launched in this subnet receive a public IPv4 address.

outpost_arn¶: The Amazon Resource Name (ARN) of the Outpost.

owner_id¶: The ID of the AWS account that owns the subnet.

state¶: The current state of the subnet.

subnet_arn¶: The Amazon Resource Name (ARN) of the subnet.

subnet_id¶: The ID of the subnet.

tags¶: Any tags assigned to the subnet.

vpc_id¶: The ID of the VPC the subnet is in.

class ec2.volume¶

Example:

resources = storage_connector.read_resources(
    service="ec2",
    resource_type="volume")
for resource in resources:
    resource.load()
    print(resource.urn)
    print(resource.attachments)
    print(resource.availability_zone)
    print(resource.create_time)
    print(resource.encrypted)
    print(resource.fast_restored)
    print(resource.iops)
    print(resource.kms_key_id)
    print(resource.multi_attach_enabled)
    print(resource.outpost_arn)
    print(resource.size)
    print(resource.snapshot_id)
    print(resource.state)
    print(resource.tags)
    print(resource.throughput)
    print(resource.volume_id)
    print(resource.volume_type)

attachments¶: Information about the volume attachments.

availability_zone¶: The Availability Zone for the volume.

create_time¶: The time stamp when volume creation was initiated.

encrypted¶: Indicates whether the volume is encrypted.

fast_restored¶: Indicates whether the volume was created using fast snapshot restore.

iops¶: The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

kms_key_id¶: The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.

multi_attach_enabled¶: Indicates whether Amazon EBS Multi-Attach is enabled.

outpost_arn¶: The Amazon Resource Name (ARN) of the Outpost.

size¶: The size of the volume, in GiBs.

snapshot_id¶: The snapshot from which the volume was created, if applicable.

state¶: The volume state.

tags¶: Any tags assigned to the volume.

throughput¶: The throughput that the volume supports, in MiB/s.

volume_id¶: The ID of the volume.

volume_type¶: The volume type.

class ec2.vpc¶

Example:

resources = storage_connector.read_resources(
    service="ec2",
    resource_type="vpc")
for resource in resources:
    resource.load()
    print(resource.urn)
    print(resource.cidr_block)
    print(resource.cidr_block_association_set)
    print(resource.dhcp_options_id)
    print(resource.instance_tenancy)
    print(resource.ipv6_cidr_block_association_set)
    print(resource.is_default)
    print(resource.owner_id)
    print(resource.state)
    print(resource.tags)
    print(resource.vpc_id)

cidr_block¶: The primary IPv4 CIDR block for the VPC.

cidr_block_association_set¶: Information about the IPv4 CIDR blocks associated with the VPC.

dhcp_options_id¶: The ID of the set of DHCP options you’ve associated with the VPC.

instance_tenancy¶: The allowed tenancy of instances launched into the VPC.

ipv6_cidr_block_association_set¶: Information about the IPv6 CIDR blocks associated with the VPC.

is_default¶: Indicates whether the VPC is the default VPC.

owner_id¶: The ID of the AWS account that owns the VPC.

state¶: The current state of the VPC.

tags¶: Any tags assigned to the VPC.

vpc_id¶: The ID of the VPC.

class ec2.vpc.vpc_enable_dns_support¶

A secondary attribute for the ec2.vpc resource type.

Example:

resources = storage_connector.read_resources(
    service="ec2",
    resource_type="vpc")
for resource in resources:
    resource.get_secondary_attribute(name="vpc_enable_dns_support")

class ec2.vpc_address¶

Example:

resources = storage_connector.read_resources(
    service="ec2",
    resource_type="vpc_address")
for resource in resources:
    resource.load()
    print(resource.urn)
    print(resource.association_id)
    print(resource.carrier_ip)
    print(resource.customer_owned_ip)
    print(resource.customer_owned_ipv4_pool)
    print(resource.domain)
    print(resource.instance_id)
    print(resource.network_border_group)
    print(resource.network_interface_id)
    print(resource.network_interface_owner_id)
    print(resource.private_ip_address)
    print(resource.public_ip)
    print(resource.public_ipv4_pool)
    print(resource.tags)

association_id¶: The ID representing the association of the address with an instance in a VPC.

carrier_ip¶: The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance).

customer_owned_ip¶: The customer-owned IP address.

customer_owned_ipv4_pool¶: The ID of the customer-owned address pool.

domain¶: Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard ) or instances in a VPC (vpc ).

instance_id¶: The ID of the instance that the address is associated with (if any).

network_border_group¶: The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.

network_interface_id¶: The ID of the network interface.

network_interface_owner_id¶: The ID of the AWS account that owns the network interface.

private_ip_address¶: The private IP address associated with the Elastic IP address.

public_ip¶: The Elastic IP address.

public_ipv4_pool¶: The ID of an address pool.

tags¶: Any tags assigned to the Elastic IP address.

class ec2.vpc_endpoint¶

Example:

resources = storage_connector.read_resources(
    service="ec2",
    resource_type="vpc_endpoint")
for resource in resources:
    resource.load()
    print(resource.urn)
    print(resource.creation_timestamp)
    print(resource.dns_entries)
    print(resource.groups)
    print(resource.last_error)
    print(resource.network_interface_ids)
    print(resource.owner_id)
    print(resource.policy_document)
    print(resource.private_dns_enabled)
    print(resource.requester_managed)
    print(resource.route_table_ids)
    print(resource.service_name)
    print(resource.state)
    print(resource.subnet_ids)
    print(resource.tags)
    print(resource.vpc_endpoint_id)
    print(resource.vpc_endpoint_type)
    print(resource.vpc_id)

creation_timestamp¶: The date and time that the VPC endpoint was created.

dns_entries¶: (Interface endpoint) The DNS entries for the endpoint.

groups¶: (Interface endpoint) Information about the security groups that are associated with the network interface.

last_error¶: The last error that occurred for VPC endpoint.

network_interface_ids¶: (Interface endpoint) One or more network interfaces for the endpoint.

owner_id¶: The ID of the AWS account that owns the VPC endpoint.

policy_document¶: The policy document associated with the endpoint, if applicable.

private_dns_enabled¶: (Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.

requester_managed¶: Indicates whether the VPC endpoint is being managed by its service.

route_table_ids¶: (Gateway endpoint) One or more route tables associated with the endpoint.

service_name¶: The name of the service to which the endpoint is associated.

state¶: The state of the VPC endpoint.

subnet_ids¶: (Interface endpoint) One or more subnets in which the endpoint is located.

tags¶: Any tags assigned to the VPC endpoint.

vpc_endpoint_id¶: The ID of the VPC endpoint.

vpc_endpoint_type¶: The type of endpoint.

vpc_id¶: The ID of the VPC to which the endpoint is associated.

class ec2.vpc_endpoint_service¶

Example:

resources = storage_connector.read_resources(
    service="ec2",
    resource_type="vpc_endpoint_service")
for resource in resources:
    resource.load()
    print(resource.urn)
    print(resource.acceptance_required)
    print(resource.availability_zones)
    print(resource.base_endpoint_dns_names)
    print(resource.manages_vpc_endpoints)
    print(resource.owner)
    print(resource.private_dns_name)
    print(resource.private_dns_name_verification_state)
    print(resource.private_dns_names)
    print(resource.service_id)
    print(resource.service_name)
    print(resource.service_type)
    print(resource.tags)
    print(resource.vpc_endpoint_policy_supported)

acceptance_required¶: Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner.

availability_zones¶: The Availability Zones in which the service is available.

base_endpoint_dns_names¶: The DNS names for the service.

manages_vpc_endpoints¶: Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted.

owner¶: The AWS account ID of the service owner.

private_dns_name¶: The private DNS name for the service.

private_dns_name_verification_state¶: The verification state of the VPC endpoint service. Consumers of the endpoint service cannot use the private name when the state is not verified .

private_dns_names¶: The private DNS names assigned to the VPC endpoint service.

service_id¶: The ID of the endpoint service.

service_name¶: The Amazon Resource Name (ARN) of the service.

service_type¶: The type of service.

tags¶: Any tags assigned to the service.

vpc_endpoint_policy_supported¶: Indicates whether the service supports endpoint policies.

class ec2.vpc_peering_connection¶

Example:

resources = storage_connector.read_resources(
    service="ec2",
    resource_type="vpc_peering_connection")
for resource in resources:
    resource.load()
    print(resource.urn)
    print(resource.accepter_vpc_info)
    print(resource.expiration_time)
    print(resource.requester_vpc_info)
    print(resource.status)
    print(resource.tags)
    print(resource.vpc_peering_connection_id)

accepter_vpc_info¶: Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection.

expiration_time¶: The time that an unaccepted VPC peering connection will expire.

requester_vpc_info¶: Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection.

status¶: The status of the VPC peering connection.

tags¶: Any tags assigned to the resource.

vpc_peering_connection_id¶: The ID of the VPC peering connection.