EC2 / Client / create_local_gateway_virtual_interface_group

create_local_gateway_virtual_interface_group¶

EC2.Client.create_local_gateway_virtual_interface_group(**kwargs)¶

Create a local gateway virtual interface group.

Request Syntax

response = client.create_local_gateway_virtual_interface_group(
    LocalGatewayId='string',
    LocalBgpAsn=123,
    LocalBgpAsnExtended=123,
    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'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'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'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    DryRun=True|False
)

Parameters:

LocalGatewayId (string) –
[REQUIRED]

The ID of the local gateway.
LocalBgpAsn (integer) – The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP).
LocalBgpAsnExtended (integer) – The extended 32-bit ASN for the local BGP configuration.
TagSpecifications (list) –
The tags to apply to the local gateway virtual interface group when the resource is being created.
- (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.
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.

Return type:

dict

Returns:

Response Syntax

{
    'LocalGatewayVirtualInterfaceGroup': {
        'LocalGatewayVirtualInterfaceGroupId': 'string',
        'LocalGatewayVirtualInterfaceIds': [
            'string',
        ],
        'LocalGatewayId': 'string',
        'OwnerId': 'string',
        'LocalBgpAsn': 123,
        'LocalBgpAsnExtended': 123,
        'LocalGatewayVirtualInterfaceGroupArn': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'ConfigurationState': 'pending'|'incomplete'|'available'|'deleting'|'deleted'
    }
}

Response Structure

(dict) –
- LocalGatewayVirtualInterfaceGroup (dict) –
  
  Information about the created local gateway virtual interface group.
  - LocalGatewayVirtualInterfaceGroupId (string) –
    
    The ID of the virtual interface group.
  - LocalGatewayVirtualInterfaceIds (list) –
    
    The IDs of the virtual interfaces.
    - (string) –
  - LocalGatewayId (string) –
    
    The ID of the local gateway.
  - OwnerId (string) –
    
    The ID of the Amazon Web Services account that owns the local gateway virtual interface group.
  - LocalBgpAsn (integer) –
    
    The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP).
  - LocalBgpAsnExtended (integer) –
    
    The extended 32-bit ASN for the local BGP configuration.
  - LocalGatewayVirtualInterfaceGroupArn (string) –
    
    The Amazon Resource Number (ARN) of the local gateway virtual interface group.
  - Tags (list) –
    
    The tags assigned to the virtual interface group.
    - (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.
  - ConfigurationState (string) –
    
    The current state of the local gateway virtual interface group.