EC2 / Client / create_secondary_network

create_secondary_network¶

EC2.Client.create_secondary_network(**kwargs)¶

Creates an Amazon secondary network.

The allowed size for a secondary network CIDR block is between /28 netmask (16 IP addresses) and /12 netmask (1,048,576 IP addresses).

Request Syntax

response = client.create_secondary_network(
    ClientToken='string',
    DryRun=True|False,
    Ipv4CidrBlock='string',
    NetworkType='rdma',
    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'|'image-usage-report'|'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-metering-policy'|'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'|'vpc-encryption-control'|'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'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
)

Parameters:

ClientToken (string) –
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure 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.
Ipv4CidrBlock (string) –
[REQUIRED]

The IPv4 CIDR block for the secondary network. The CIDR block size must be between /12 and /28.
NetworkType (string) –
[REQUIRED]

The type of secondary network.
TagSpecifications (list) –
The tags to assign to the secondary network.
- (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

{
    'SecondaryNetwork': {
        'SecondaryNetworkId': 'string',
        'SecondaryNetworkArn': 'string',
        'OwnerId': 'string',
        'Type': 'rdma',
        'State': 'create-in-progress'|'create-complete'|'create-failed'|'delete-in-progress'|'delete-complete'|'delete-failed',
        'StateReason': 'string',
        'Ipv4CidrBlockAssociations': [
            {
                'AssociationId': 'string',
                'CidrBlock': 'string',
                'State': 'associating'|'associated'|'association-failed'|'disassociating'|'disassociated'|'disassociation-failed',
                'StateReason': 'string'
            },
        ],
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    },
    'ClientToken': 'string'
}

Response Structure

(dict) –
- SecondaryNetwork (dict) –
  
  Information about the secondary network.
  - SecondaryNetworkId (string) –
    
    The ID of the secondary network.
  - SecondaryNetworkArn (string) –
    
    The Amazon Resource Name (ARN) of the secondary network.
  - OwnerId (string) –
    
    The ID of the Amazon Web Services account that owns the secondary network.
  - Type (string) –
    
    The type of the secondary network.
  - State (string) –
    
    The state of the secondary network.
  - StateReason (string) –
    
    The reason for the current state of the secondary network.
  - Ipv4CidrBlockAssociations (list) –
    
    Information about the IPv4 CIDR blocks associated with the secondary network.
    - (dict) –
      
      Describes an IPv4 CIDR block associated with a secondary network.
      - AssociationId (string) –
        
        The association ID for the IPv4 CIDR block.
      - CidrBlock (string) –
        
        The IPv4 CIDR block.
      - State (string) –
        
        The state of the CIDR block association.
      - StateReason (string) –
        
        The reason for the current state of the CIDR block association.
  - Tags (list) –
    
    The tags assigned to the secondary network.
    - (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 identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.