amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.AssociateTrunkInterface

Description

This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.

Associates a branch network interface with a trunk network interface.

Before you create the association, run the create-network-interface command and set --interface-type to trunk. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.

Synopsis

Creating a Request

data AssociateTrunkInterface Source #

See: newAssociateTrunkInterface smart constructor.

Constructors

AssociateTrunkInterface' 

Fields

  • clientToken :: Maybe Text

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

  • dryRun :: Maybe Bool

    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.

  • greKey :: Maybe Int

    The application key. This applies to the GRE protocol.

  • vlanId :: Maybe Int

    The ID of the VLAN. This applies to the VLAN protocol.

  • branchInterfaceId :: Text

    The ID of the branch network interface.

  • trunkInterfaceId :: Text

    The ID of the trunk network interface.

Instances

Instances details
ToHeaders AssociateTrunkInterface Source # 
Instance details

Defined in Amazonka.EC2.AssociateTrunkInterface

ToPath AssociateTrunkInterface Source # 
Instance details

Defined in Amazonka.EC2.AssociateTrunkInterface

ToQuery AssociateTrunkInterface Source # 
Instance details

Defined in Amazonka.EC2.AssociateTrunkInterface

AWSRequest AssociateTrunkInterface Source # 
Instance details

Defined in Amazonka.EC2.AssociateTrunkInterface

Generic AssociateTrunkInterface Source # 
Instance details

Defined in Amazonka.EC2.AssociateTrunkInterface

Associated Types

type Rep AssociateTrunkInterface :: Type -> Type #

Read AssociateTrunkInterface Source # 
Instance details

Defined in Amazonka.EC2.AssociateTrunkInterface

Show AssociateTrunkInterface Source # 
Instance details

Defined in Amazonka.EC2.AssociateTrunkInterface

NFData AssociateTrunkInterface Source # 
Instance details

Defined in Amazonka.EC2.AssociateTrunkInterface

Methods

rnf :: AssociateTrunkInterface -> () #

Eq AssociateTrunkInterface Source # 
Instance details

Defined in Amazonka.EC2.AssociateTrunkInterface

Hashable AssociateTrunkInterface Source # 
Instance details

Defined in Amazonka.EC2.AssociateTrunkInterface

type AWSResponse AssociateTrunkInterface Source # 
Instance details

Defined in Amazonka.EC2.AssociateTrunkInterface

type Rep AssociateTrunkInterface Source # 
Instance details

Defined in Amazonka.EC2.AssociateTrunkInterface

type Rep AssociateTrunkInterface = D1 ('MetaData "AssociateTrunkInterface" "Amazonka.EC2.AssociateTrunkInterface" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "AssociateTrunkInterface'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "greKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "vlanId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "branchInterfaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "trunkInterfaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newAssociateTrunkInterface Source #

Create a value of AssociateTrunkInterface with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

AssociateTrunkInterface, associateTrunkInterface_clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

$sel:dryRun:AssociateTrunkInterface', associateTrunkInterface_dryRun - 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.

AssociateTrunkInterface, associateTrunkInterface_greKey - The application key. This applies to the GRE protocol.

AssociateTrunkInterface, associateTrunkInterface_vlanId - The ID of the VLAN. This applies to the VLAN protocol.

AssociateTrunkInterface, associateTrunkInterface_branchInterfaceId - The ID of the branch network interface.

AssociateTrunkInterface, associateTrunkInterface_trunkInterfaceId - The ID of the trunk network interface.

Request Lenses

associateTrunkInterface_clientToken :: Lens' AssociateTrunkInterface (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

associateTrunkInterface_dryRun :: Lens' AssociateTrunkInterface (Maybe Bool) Source #

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.

associateTrunkInterface_greKey :: Lens' AssociateTrunkInterface (Maybe Int) Source #

The application key. This applies to the GRE protocol.

associateTrunkInterface_vlanId :: Lens' AssociateTrunkInterface (Maybe Int) Source #

The ID of the VLAN. This applies to the VLAN protocol.

Destructuring the Response

data AssociateTrunkInterfaceResponse Source #

See: newAssociateTrunkInterfaceResponse smart constructor.

Constructors

AssociateTrunkInterfaceResponse' 

Fields

Instances

Instances details
Generic AssociateTrunkInterfaceResponse Source # 
Instance details

Defined in Amazonka.EC2.AssociateTrunkInterface

Associated Types

type Rep AssociateTrunkInterfaceResponse :: Type -> Type #

Read AssociateTrunkInterfaceResponse Source # 
Instance details

Defined in Amazonka.EC2.AssociateTrunkInterface

Show AssociateTrunkInterfaceResponse Source # 
Instance details

Defined in Amazonka.EC2.AssociateTrunkInterface

NFData AssociateTrunkInterfaceResponse Source # 
Instance details

Defined in Amazonka.EC2.AssociateTrunkInterface

Eq AssociateTrunkInterfaceResponse Source # 
Instance details

Defined in Amazonka.EC2.AssociateTrunkInterface

type Rep AssociateTrunkInterfaceResponse Source # 
Instance details

Defined in Amazonka.EC2.AssociateTrunkInterface

type Rep AssociateTrunkInterfaceResponse = D1 ('MetaData "AssociateTrunkInterfaceResponse" "Amazonka.EC2.AssociateTrunkInterface" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "AssociateTrunkInterfaceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "interfaceAssociation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TrunkInterfaceAssociation)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newAssociateTrunkInterfaceResponse Source #

Create a value of AssociateTrunkInterfaceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

AssociateTrunkInterface, associateTrunkInterfaceResponse_clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

$sel:interfaceAssociation:AssociateTrunkInterfaceResponse', associateTrunkInterfaceResponse_interfaceAssociation - Information about the association between the trunk network interface and branch network interface.

$sel:httpStatus:AssociateTrunkInterfaceResponse', associateTrunkInterfaceResponse_httpStatus - The response's http status code.

Response Lenses

associateTrunkInterfaceResponse_clientToken :: Lens' AssociateTrunkInterfaceResponse (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

associateTrunkInterfaceResponse_interfaceAssociation :: Lens' AssociateTrunkInterfaceResponse (Maybe TrunkInterfaceAssociation) Source #

Information about the association between the trunk network interface and branch network interface.