EC2 / Client / create_instance_connect_endpoint

create_instance_connect_endpoint#

EC2.Client.create_instance_connect_endpoint(**kwargs)#

Creates an EC2 Instance Connect Endpoint.

An EC2 Instance Connect Endpoint allows you to connect to an instance, without requiring the instance to have a public IPv4 address. For more information, see Connect to your instances without requiring a public IPv4 address using EC2 Instance Connect Endpoint in the Amazon EC2 User Guide.

Request Syntax

response = client.create_instance_connect_endpoint(
    DryRun=True|False,
    SubnetId='string',
    SecurityGroupIds=[
        'string',
    ],
    PreserveClientIp=True|False,
    ClientToken='string',
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'ipam-external-resource-verification-token',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
)

Parameters:

DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
SubnetId (string) –
[REQUIRED]

The ID of the subnet in which to create the EC2 Instance Connect Endpoint.
SecurityGroupIds (list) –
One or more security groups to associate with the endpoint. If you don’t specify a security group, the default security group for your VPC will be associated with the endpoint.
- (string) –
PreserveClientIp (boolean) –
Indicates whether the client IP address is preserved as the source. The following are the possible values.
- true - Use the client IP address as the source.
- false - Use the network interface IP address as the source.
Default: false
ClientToken (string) –
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.
TagSpecifications (list) –
The tags to apply to the EC2 Instance Connect Endpoint during creation.
- (dict) –
  
  The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
  
  Note
  The Valid Values lists all the resource types that can be tagged. However, the action you’re using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you’re using, you’ll get an error.
  - ResourceType (string) –
    
    The type of resource to tag on creation.
  - Tags (list) –
    
    The tags to apply to the resource.
    - (dict) –
      
      Describes a tag.
      - Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
      - Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Return type:

dict

Returns:

Response Syntax

{
    'InstanceConnectEndpoint': {
        'OwnerId': 'string',
        'InstanceConnectEndpointId': 'string',
        'InstanceConnectEndpointArn': 'string',
        'State': 'create-in-progress'|'create-complete'|'create-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
        'StateMessage': 'string',
        'DnsName': 'string',
        'FipsDnsName': 'string',
        'NetworkInterfaceIds': [
            'string',
        ],
        'VpcId': 'string',
        'AvailabilityZone': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'SubnetId': 'string',
        'PreserveClientIp': True|False,
        'SecurityGroupIds': [
            'string',
        ],
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    },
    'ClientToken': 'string'
}

Response Structure

(dict) –
- InstanceConnectEndpoint (dict) –
  
  Information about the EC2 Instance Connect Endpoint.
  - OwnerId (string) –
    
    The ID of the Amazon Web Services account that created the EC2 Instance Connect Endpoint.
  - InstanceConnectEndpointId (string) –
    
    The ID of the EC2 Instance Connect Endpoint.
  - InstanceConnectEndpointArn (string) –
    
    The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint.
  - State (string) –
    
    The current state of the EC2 Instance Connect Endpoint.
  - StateMessage (string) –
    
    The message for the current state of the EC2 Instance Connect Endpoint. Can include a failure message.
  - DnsName (string) –
    
    The DNS name of the EC2 Instance Connect Endpoint.
  - FipsDnsName (string) –
  - NetworkInterfaceIds (list) –
    
    The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint.
    - (string) –
  - VpcId (string) –
    
    The ID of the VPC in which the EC2 Instance Connect Endpoint was created.
  - AvailabilityZone (string) –
    
    The Availability Zone of the EC2 Instance Connect Endpoint.
  - CreatedAt (datetime) –
    
    The date and time that the EC2 Instance Connect Endpoint was created.
  - SubnetId (string) –
    
    The ID of the subnet in which the EC2 Instance Connect Endpoint was created.
  - PreserveClientIp (boolean) –
    
    Indicates whether your client’s IP address is preserved as the source. The value is true or false.
    - If true, your client’s IP address is used when you connect to a resource.
    - If false, the elastic network interface IP address is used when you connect to a resource.
    Default: true
  - SecurityGroupIds (list) –
    
    The security groups associated with the endpoint. If you didn’t specify a security group, the default security group for your VPC is associated with the endpoint.
    - (string) –
  - Tags (list) –
    
    The tags assigned to the EC2 Instance Connect Endpoint.
    - (dict) –
      
      Describes a tag.
      - Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
      - Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
- ClientToken (string) –
  
  Unique, case-sensitive idempotency token provided by the client in the the request.