EC2 / Client / create_verified_access_endpoint

create_verified_access_endpoint#

EC2.Client.create_verified_access_endpoint(**kwargs)#

An Amazon Web Services Verified Access endpoint is where you define your application along with an optional endpoint-level access policy.

Request Syntax

response = client.create_verified_access_endpoint(
    VerifiedAccessGroupId='string',
    EndpointType='load-balancer'|'network-interface'|'rds'|'cidr',
    AttachmentType='vpc',
    DomainCertificateArn='string',
    ApplicationDomain='string',
    EndpointDomainPrefix='string',
    SecurityGroupIds=[
        'string',
    ],
    LoadBalancerOptions={
        'Protocol': 'http'|'https'|'tcp',
        'Port': 123,
        'LoadBalancerArn': 'string',
        'SubnetIds': [
            'string',
        ],
        'PortRanges': [
            {
                'FromPort': 123,
                'ToPort': 123
            },
        ]
    },
    NetworkInterfaceOptions={
        'NetworkInterfaceId': 'string',
        'Protocol': 'http'|'https'|'tcp',
        'Port': 123,
        'PortRanges': [
            {
                'FromPort': 123,
                'ToPort': 123
            },
        ]
    },
    Description='string',
    PolicyDocument='string',
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'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'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    ClientToken='string',
    DryRun=True|False,
    SseSpecification={
        'CustomerManagedKeyEnabled': True|False,
        'KmsKeyArn': 'string'
    },
    RdsOptions={
        'Protocol': 'http'|'https'|'tcp',
        'Port': 123,
        'RdsDbInstanceArn': 'string',
        'RdsDbClusterArn': 'string',
        'RdsDbProxyArn': 'string',
        'RdsEndpoint': 'string',
        'SubnetIds': [
            'string',
        ]
    },
    CidrOptions={
        'Protocol': 'http'|'https'|'tcp',
        'SubnetIds': [
            'string',
        ],
        'Cidr': 'string',
        'PortRanges': [
            {
                'FromPort': 123,
                'ToPort': 123
            },
        ]
    }
)

Parameters:

VerifiedAccessGroupId (string) –
[REQUIRED]

The ID of the Verified Access group to associate the endpoint with.
EndpointType (string) –
[REQUIRED]

The type of Verified Access endpoint to create.
AttachmentType (string) –
[REQUIRED]

The type of attachment.
DomainCertificateArn (string) – The ARN of the public TLS/SSL certificate in Amazon Web Services Certificate Manager to associate with the endpoint. The CN in the certificate must match the DNS name your end users will use to reach your application.
ApplicationDomain (string) – The DNS name for users to reach your application.
EndpointDomainPrefix (string) – A custom identifier that is prepended to the DNS name that is generated for the endpoint.
SecurityGroupIds (list) –
The IDs of the security groups to associate with the Verified Access endpoint. Required if AttachmentType is set to vpc.
- (string) –
LoadBalancerOptions (dict) –
The load balancer details. This parameter is required if the endpoint type is load-balancer.
- Protocol (string) –
  
  The IP protocol.
- Port (integer) –
  
  The IP port number.
- LoadBalancerArn (string) –
  
  The ARN of the load balancer.
- SubnetIds (list) –
  
  The IDs of the subnets.
  - (string) –
- PortRanges (list) –
  
  The port ranges.
  - (dict) –
    
    Describes the port range for a Verified Access endpoint.
    - FromPort (integer) –
      
      The start of the port range.
    - ToPort (integer) –
      
      The end of the port range.
NetworkInterfaceOptions (dict) –
The network interface details. This parameter is required if the endpoint type is network-interface.
- NetworkInterfaceId (string) –
  
  The ID of the network interface.
- Protocol (string) –
  
  The IP protocol.
- Port (integer) –
  
  The IP port number.
- PortRanges (list) –
  
  The port ranges.
  - (dict) –
    
    Describes the port range for a Verified Access endpoint.
    - FromPort (integer) –
      
      The start of the port range.
    - ToPort (integer) –
      
      The end of the port range.
Description (string) – A description for the Verified Access endpoint.
PolicyDocument (string) – The Verified Access policy document.
TagSpecifications (list) –
The tags to assign to the Verified Access endpoint.
- (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.
ClientToken (string) –
A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.
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.
SseSpecification (dict) –
The options for server side encryption.
- CustomerManagedKeyEnabled (boolean) –
  
  Enable or disable the use of customer managed KMS keys for server side encryption.
  
  Valid values: True | False
- KmsKeyArn (string) –
  
  The ARN of the KMS key.
RdsOptions (dict) –
The RDS details. This parameter is required if the endpoint type is rds.
- Protocol (string) –
  
  The protocol.
- Port (integer) –
  
  The port.
- RdsDbInstanceArn (string) –
  
  The ARN of the RDS instance.
- RdsDbClusterArn (string) –
  
  The ARN of the DB cluster.
- RdsDbProxyArn (string) –
  
  The ARN of the RDS proxy.
- RdsEndpoint (string) –
  
  The RDS endpoint.
- SubnetIds (list) –
  
  The IDs of the subnets.
  - (string) –
CidrOptions (dict) –
The CIDR options. This parameter is required if the endpoint type is cidr.
- Protocol (string) –
  
  The protocol.
- SubnetIds (list) –
  
  The IDs of the subnets.
  - (string) –
- Cidr (string) –
  
  The CIDR.
- PortRanges (list) –
  
  The port ranges.
  - (dict) –
    
    Describes the port range for a Verified Access endpoint.
    - FromPort (integer) –
      
      The start of the port range.
    - ToPort (integer) –
      
      The end of the port range.

Return type:

dict

Returns:

Response Syntax

{
    'VerifiedAccessEndpoint': {
        'VerifiedAccessInstanceId': 'string',
        'VerifiedAccessGroupId': 'string',
        'VerifiedAccessEndpointId': 'string',
        'ApplicationDomain': 'string',
        'EndpointType': 'load-balancer'|'network-interface'|'rds'|'cidr',
        'AttachmentType': 'vpc',
        'DomainCertificateArn': 'string',
        'EndpointDomain': 'string',
        'DeviceValidationDomain': 'string',
        'SecurityGroupIds': [
            'string',
        ],
        'LoadBalancerOptions': {
            'Protocol': 'http'|'https'|'tcp',
            'Port': 123,
            'LoadBalancerArn': 'string',
            'SubnetIds': [
                'string',
            ],
            'PortRanges': [
                {
                    'FromPort': 123,
                    'ToPort': 123
                },
            ]
        },
        'NetworkInterfaceOptions': {
            'NetworkInterfaceId': 'string',
            'Protocol': 'http'|'https'|'tcp',
            'Port': 123,
            'PortRanges': [
                {
                    'FromPort': 123,
                    'ToPort': 123
                },
            ]
        },
        'Status': {
            'Code': 'pending'|'active'|'updating'|'deleting'|'deleted',
            'Message': 'string'
        },
        'Description': 'string',
        'CreationTime': 'string',
        'LastUpdatedTime': 'string',
        'DeletionTime': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'SseSpecification': {
            'CustomerManagedKeyEnabled': True|False,
            'KmsKeyArn': 'string'
        },
        'RdsOptions': {
            'Protocol': 'http'|'https'|'tcp',
            'Port': 123,
            'RdsDbInstanceArn': 'string',
            'RdsDbClusterArn': 'string',
            'RdsDbProxyArn': 'string',
            'RdsEndpoint': 'string',
            'SubnetIds': [
                'string',
            ]
        },
        'CidrOptions': {
            'Cidr': 'string',
            'PortRanges': [
                {
                    'FromPort': 123,
                    'ToPort': 123
                },
            ],
            'Protocol': 'http'|'https'|'tcp',
            'SubnetIds': [
                'string',
            ]
        }
    }
}

Response Structure

(dict) –
- VerifiedAccessEndpoint (dict) –
  
  Details about the Verified Access endpoint.
  - VerifiedAccessInstanceId (string) –
    
    The ID of the Amazon Web Services Verified Access instance.
  - VerifiedAccessGroupId (string) –
    
    The ID of the Amazon Web Services Verified Access group.
  - VerifiedAccessEndpointId (string) –
    
    The ID of the Amazon Web Services Verified Access endpoint.
  - ApplicationDomain (string) –
    
    The DNS name for users to reach your application.
  - EndpointType (string) –
    
    The type of Amazon Web Services Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.
  - AttachmentType (string) –
    
    The type of attachment used to provide connectivity between the Amazon Web Services Verified Access endpoint and the application.
  - DomainCertificateArn (string) –
    
    The ARN of a public TLS/SSL certificate imported into or created with ACM.
  - EndpointDomain (string) –
    
    A DNS name that is generated for the endpoint.
  - DeviceValidationDomain (string) –
    
    Returned if endpoint has a device trust provider attached.
  - SecurityGroupIds (list) –
    
    The IDs of the security groups for the endpoint.
    - (string) –
  - LoadBalancerOptions (dict) –
    
    The load balancer details if creating the Amazon Web Services Verified Access endpoint as ``load-balancer``type.
    - Protocol (string) –
      
      The IP protocol.
    - Port (integer) –
      
      The IP port number.
    - LoadBalancerArn (string) –
      
      The ARN of the load balancer.
    - SubnetIds (list) –
      
      The IDs of the subnets.
      - (string) –
    - PortRanges (list) –
      
      The port ranges.
      - (dict) –
        
        Describes a port range.
        
        FromPort (integer) –
        
        The start of the port range.
        
        ToPort (integer) –
        
        The end of the port range.
  - NetworkInterfaceOptions (dict) –
    
    The options for network-interface type endpoint.
    - NetworkInterfaceId (string) –
      
      The ID of the network interface.
    - Protocol (string) –
      
      The IP protocol.
    - Port (integer) –
      
      The IP port number.
    - PortRanges (list) –
      
      The port ranges.
      - (dict) –
        
        Describes a port range.
        
        FromPort (integer) –
        
        The start of the port range.
        
        ToPort (integer) –
        
        The end of the port range.
  - Status (dict) –
    
    The endpoint status.
    - Code (string) –
      
      The status code of the Verified Access endpoint.
    - Message (string) –
      
      The status message of the Verified Access endpoint.
  - Description (string) –
    
    A description for the Amazon Web Services Verified Access endpoint.
  - CreationTime (string) –
    
    The creation time.
  - LastUpdatedTime (string) –
    
    The last updated time.
  - DeletionTime (string) –
    
    The deletion time.
  - Tags (list) –
    
    The tags.
    - (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.
  - SseSpecification (dict) –
    
    The options in use for server side encryption.
    - CustomerManagedKeyEnabled (boolean) –
      
      Indicates whether customer managed KMS keys are in use for server side encryption.
      
      Valid values: True | False
    - KmsKeyArn (string) –
      
      The ARN of the KMS key.
  - RdsOptions (dict) –
    
    The options for an RDS endpoint.
    - Protocol (string) –
      
      The protocol.
    - Port (integer) –
      
      The port.
    - RdsDbInstanceArn (string) –
      
      The ARN of the RDS instance.
    - RdsDbClusterArn (string) –
      
      The ARN of the DB cluster.
    - RdsDbProxyArn (string) –
      
      The ARN of the RDS proxy.
    - RdsEndpoint (string) –
      
      The RDS endpoint.
    - SubnetIds (list) –
      
      The IDs of the subnets.
      - (string) –
  - CidrOptions (dict) –
    
    The options for a CIDR endpoint.
    - Cidr (string) –
      
      The CIDR.
    - PortRanges (list) –
      
      The port ranges.
      - (dict) –
        
        Describes a port range.
        
        FromPort (integer) –
        
        The start of the port range.
        
        ToPort (integer) –
        
        The end of the port range.
    - Protocol (string) –
      
      The protocol.
    - SubnetIds (list) –
      
      The IDs of the subnets.
      - (string) –