EVS / Client / associate_eip_to_vlan

associate_eip_to_vlan¶

EVS.Client.associate_eip_to_vlan(**kwargs)¶

Associates an Elastic IP address with a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.

Request Syntax

response = client.associate_eip_to_vlan(
    clientToken='string',
    environmentId='string',
    vlanName='string',
    allocationId='string'
)

Parameters:

clientToken (string) –

Note
This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.

A unique, case-sensitive identifier that you provide to ensure the idempotency of the environment creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.

This field is autopopulated if not provided.
environmentId (string) –
[REQUIRED]

A unique ID for the environment containing the VLAN that the Elastic IP address associates with.
vlanName (string) –
[REQUIRED]

The name of the VLAN. hcx is the only accepted VLAN name at this time.
allocationId (string) –
[REQUIRED]

The Elastic IP address allocation ID.

Return type:

dict

Returns:

Response Syntax

{
    'vlan': {
        'vlanId': 123,
        'cidr': 'string',
        'availabilityZone': 'string',
        'functionName': 'string',
        'subnetId': 'string',
        'createdAt': datetime(2015, 1, 1),
        'modifiedAt': datetime(2015, 1, 1),
        'vlanState': 'CREATING'|'CREATED'|'DELETING'|'DELETED'|'CREATE_FAILED',
        'stateDetails': 'string',
        'eipAssociations': [
            {
                'associationId': 'string',
                'allocationId': 'string',
                'ipAddress': 'string'
            },
        ],
        'isPublic': True|False,
        'networkAclId': 'string'
    }
}

Response Structure

(dict) –
- vlan (dict) –
  
  The VLANs that Amazon EVS creates during environment creation.
  - vlanId (integer) –
    
    The unique ID of the VLAN.
  - cidr (string) –
    
    The CIDR block of the VLAN. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24.
  - availabilityZone (string) –
    
    The availability zone of the VLAN.
  - functionName (string) –
    
    The VMware VCF traffic type that is carried over the VLAN. For example, a VLAN with a functionName of hcx is being used to carry VMware HCX traffic.
  - subnetId (string) –
    
    The unique ID of the VLAN subnet.
  - createdAt (datetime) –
    
    The date and time that the VLAN was created.
  - modifiedAt (datetime) –
    
    The date and time that the VLAN was modified.
  - vlanState (string) –
    
    The state of the VLAN.
  - stateDetails (string) –
    
    The state details of the VLAN.
  - eipAssociations (list) –
    
    An array of Elastic IP address associations.
    - (dict) –
      
      An Elastic IP address association with the elastic network interface in the VLAN subnet.
      - associationId (string) –
        
        A unique ID for the elastic IP address association with the VLAN subnet.
      - allocationId (string) –
        
        The Elastic IP address allocation ID.
      - ipAddress (string) –
        
        The Elastic IP address.
  - isPublic (boolean) –
    
    Determines if the VLAN that Amazon EVS provisions is public or private.
  - networkAclId (string) –
    
    A unique ID for a network access control list.

Exceptions

EVS.Client.exceptions.ThrottlingException
EVS.Client.exceptions.ValidationException
EVS.Client.exceptions.ResourceNotFoundException