Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EC2.RegisterTransitGatewayMulticastGroupSources

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Registers sources (network interfaces) with the specified transit gateway multicast group.

A multicast source is a network interface attached to a supported instance that sends multicast traffic. For information about supported instances, see Multicast Considerations in Amazon VPC Transit Gateways.

After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group.

Synopsis

Creating a Request

data RegisterTransitGatewayMulticastGroupSources Source #

See: newRegisterTransitGatewayMulticastGroupSources smart constructor.

Constructors

RegisterTransitGatewayMulticastGroupSources'

Fields

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.
groupIpAddress :: Maybe Text
The IP address assigned to the transit gateway multicast group.
networkInterfaceIds :: Maybe [Text]
The group sources' network interface IDs to register with the transit gateway multicast group.
transitGatewayMulticastDomainId :: Maybe Text
The ID of the transit gateway multicast domain.

Instances

Instances details

ToHeaders RegisterTransitGatewayMulticastGroupSources Source #
Instance details Defined in Amazonka.EC2.RegisterTransitGatewayMulticastGroupSources Methods toHeaders :: RegisterTransitGatewayMulticastGroupSources -> [Header] #
ToPath RegisterTransitGatewayMulticastGroupSources Source #
Instance details Defined in Amazonka.EC2.RegisterTransitGatewayMulticastGroupSources Methods toPath :: RegisterTransitGatewayMulticastGroupSources -> ByteString #
ToQuery RegisterTransitGatewayMulticastGroupSources Source #
Instance details Defined in Amazonka.EC2.RegisterTransitGatewayMulticastGroupSources Methods toQuery :: RegisterTransitGatewayMulticastGroupSources -> QueryString #
AWSRequest RegisterTransitGatewayMulticastGroupSources Source #
Instance details Defined in Amazonka.EC2.RegisterTransitGatewayMulticastGroupSources Associated Types type AWSResponse RegisterTransitGatewayMulticastGroupSources # Methods request :: (Service -> Service) -> RegisterTransitGatewayMulticastGroupSources -> Request RegisterTransitGatewayMulticastGroupSources # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RegisterTransitGatewayMulticastGroupSources -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RegisterTransitGatewayMulticastGroupSources))) #
Generic RegisterTransitGatewayMulticastGroupSources Source #
Instance details Defined in Amazonka.EC2.RegisterTransitGatewayMulticastGroupSources Associated Types type Rep RegisterTransitGatewayMulticastGroupSources :: Type -> Type # Methods from :: RegisterTransitGatewayMulticastGroupSources -> Rep RegisterTransitGatewayMulticastGroupSources x # to :: Rep RegisterTransitGatewayMulticastGroupSources x -> RegisterTransitGatewayMulticastGroupSources #
Read RegisterTransitGatewayMulticastGroupSources Source #
Instance details Defined in Amazonka.EC2.RegisterTransitGatewayMulticastGroupSources Methods readsPrec :: Int -> ReadS RegisterTransitGatewayMulticastGroupSources # readList :: ReadS [RegisterTransitGatewayMulticastGroupSources] # readPrec :: ReadPrec RegisterTransitGatewayMulticastGroupSources # readListPrec :: ReadPrec [RegisterTransitGatewayMulticastGroupSources] #
Show RegisterTransitGatewayMulticastGroupSources Source #
Instance details Defined in Amazonka.EC2.RegisterTransitGatewayMulticastGroupSources Methods showsPrec :: Int -> RegisterTransitGatewayMulticastGroupSources -> ShowS # show :: RegisterTransitGatewayMulticastGroupSources -> String # showList :: [RegisterTransitGatewayMulticastGroupSources] -> ShowS #
NFData RegisterTransitGatewayMulticastGroupSources Source #
Instance details Defined in Amazonka.EC2.RegisterTransitGatewayMulticastGroupSources Methods rnf :: RegisterTransitGatewayMulticastGroupSources -> () #
Eq RegisterTransitGatewayMulticastGroupSources Source #
Instance details Defined in Amazonka.EC2.RegisterTransitGatewayMulticastGroupSources Methods (==) :: RegisterTransitGatewayMulticastGroupSources -> RegisterTransitGatewayMulticastGroupSources -> Bool # (/=) :: RegisterTransitGatewayMulticastGroupSources -> RegisterTransitGatewayMulticastGroupSources -> Bool #
Hashable RegisterTransitGatewayMulticastGroupSources Source #
Instance details Defined in Amazonka.EC2.RegisterTransitGatewayMulticastGroupSources Methods hashWithSalt :: Int -> RegisterTransitGatewayMulticastGroupSources -> Int # hash :: RegisterTransitGatewayMulticastGroupSources -> Int #
type AWSResponse RegisterTransitGatewayMulticastGroupSources Source #
Instance details Defined in Amazonka.EC2.RegisterTransitGatewayMulticastGroupSources type AWSResponse RegisterTransitGatewayMulticastGroupSources = RegisterTransitGatewayMulticastGroupSourcesResponse
type Rep RegisterTransitGatewayMulticastGroupSources Source #
Instance details Defined in Amazonka.EC2.RegisterTransitGatewayMulticastGroupSources type Rep RegisterTransitGatewayMulticastGroupSources = D1 ('MetaData "RegisterTransitGatewayMulticastGroupSources" "Amazonka.EC2.RegisterTransitGatewayMulticastGroupSources" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "RegisterTransitGatewayMulticastGroupSources'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "groupIpAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "networkInterfaceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "transitGatewayMulticastDomainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newRegisterTransitGatewayMulticastGroupSources :: RegisterTransitGatewayMulticastGroupSources Source #

Create a value of RegisterTransitGatewayMulticastGroupSources 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:

$sel:dryRun:RegisterTransitGatewayMulticastGroupSources', registerTransitGatewayMulticastGroupSources_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.

RegisterTransitGatewayMulticastGroupSources, registerTransitGatewayMulticastGroupSources_groupIpAddress - The IP address assigned to the transit gateway multicast group.

RegisterTransitGatewayMulticastGroupSources, registerTransitGatewayMulticastGroupSources_networkInterfaceIds - The group sources' network interface IDs to register with the transit gateway multicast group.

RegisterTransitGatewayMulticastGroupSources, registerTransitGatewayMulticastGroupSources_transitGatewayMulticastDomainId - The ID of the transit gateway multicast domain.

Request Lenses

registerTransitGatewayMulticastGroupSources_dryRun :: Lens' RegisterTransitGatewayMulticastGroupSources (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.

registerTransitGatewayMulticastGroupSources_groupIpAddress :: Lens' RegisterTransitGatewayMulticastGroupSources (Maybe Text) Source #

The IP address assigned to the transit gateway multicast group.

registerTransitGatewayMulticastGroupSources_networkInterfaceIds :: Lens' RegisterTransitGatewayMulticastGroupSources (Maybe [Text]) Source #

The group sources' network interface IDs to register with the transit gateway multicast group.

registerTransitGatewayMulticastGroupSources_transitGatewayMulticastDomainId :: Lens' RegisterTransitGatewayMulticastGroupSources (Maybe Text) Source #

The ID of the transit gateway multicast domain.

Destructuring the Response

data RegisterTransitGatewayMulticastGroupSourcesResponse Source #

See: newRegisterTransitGatewayMulticastGroupSourcesResponse smart constructor.

Constructors

RegisterTransitGatewayMulticastGroupSourcesResponse'
Fields registeredMulticastGroupSources :: Maybe TransitGatewayMulticastRegisteredGroupSources Information about the transit gateway multicast group sources. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic RegisterTransitGatewayMulticastGroupSourcesResponse Source #
Instance details Defined in Amazonka.EC2.RegisterTransitGatewayMulticastGroupSources Associated Types type Rep RegisterTransitGatewayMulticastGroupSourcesResponse :: Type -> Type # Methods from :: RegisterTransitGatewayMulticastGroupSourcesResponse -> Rep RegisterTransitGatewayMulticastGroupSourcesResponse x # to :: Rep RegisterTransitGatewayMulticastGroupSourcesResponse x -> RegisterTransitGatewayMulticastGroupSourcesResponse #
Read RegisterTransitGatewayMulticastGroupSourcesResponse Source #
Instance details Defined in Amazonka.EC2.RegisterTransitGatewayMulticastGroupSources Methods readsPrec :: Int -> ReadS RegisterTransitGatewayMulticastGroupSourcesResponse # readList :: ReadS [RegisterTransitGatewayMulticastGroupSourcesResponse] # readPrec :: ReadPrec RegisterTransitGatewayMulticastGroupSourcesResponse # readListPrec :: ReadPrec [RegisterTransitGatewayMulticastGroupSourcesResponse] #
Show RegisterTransitGatewayMulticastGroupSourcesResponse Source #
Instance details Defined in Amazonka.EC2.RegisterTransitGatewayMulticastGroupSources Methods showsPrec :: Int -> RegisterTransitGatewayMulticastGroupSourcesResponse -> ShowS # show :: RegisterTransitGatewayMulticastGroupSourcesResponse -> String # showList :: [RegisterTransitGatewayMulticastGroupSourcesResponse] -> ShowS #
NFData RegisterTransitGatewayMulticastGroupSourcesResponse Source #
Instance details Defined in Amazonka.EC2.RegisterTransitGatewayMulticastGroupSources Methods rnf :: RegisterTransitGatewayMulticastGroupSourcesResponse -> () #
Eq RegisterTransitGatewayMulticastGroupSourcesResponse Source #
Instance details Defined in Amazonka.EC2.RegisterTransitGatewayMulticastGroupSources Methods (==) :: RegisterTransitGatewayMulticastGroupSourcesResponse -> RegisterTransitGatewayMulticastGroupSourcesResponse -> Bool # (/=) :: RegisterTransitGatewayMulticastGroupSourcesResponse -> RegisterTransitGatewayMulticastGroupSourcesResponse -> Bool #
type Rep RegisterTransitGatewayMulticastGroupSourcesResponse Source #
Instance details Defined in Amazonka.EC2.RegisterTransitGatewayMulticastGroupSources type Rep RegisterTransitGatewayMulticastGroupSourcesResponse = D1 ('MetaData "RegisterTransitGatewayMulticastGroupSourcesResponse" "Amazonka.EC2.RegisterTransitGatewayMulticastGroupSources" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "RegisterTransitGatewayMulticastGroupSourcesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "registeredMulticastGroupSources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TransitGatewayMulticastRegisteredGroupSources)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRegisterTransitGatewayMulticastGroupSourcesResponse Source #

Arguments

:: Int	`$sel:httpStatus:RegisterTransitGatewayMulticastGroupSourcesResponse'`
-> RegisterTransitGatewayMulticastGroupSourcesResponse

Create a value of RegisterTransitGatewayMulticastGroupSourcesResponse 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:

$sel:registeredMulticastGroupSources:RegisterTransitGatewayMulticastGroupSourcesResponse', registerTransitGatewayMulticastGroupSourcesResponse_registeredMulticastGroupSources - Information about the transit gateway multicast group sources.

$sel:httpStatus:RegisterTransitGatewayMulticastGroupSourcesResponse', registerTransitGatewayMulticastGroupSourcesResponse_httpStatus - The response's http status code.

Response Lenses

registerTransitGatewayMulticastGroupSourcesResponse_registeredMulticastGroupSources :: Lens' RegisterTransitGatewayMulticastGroupSourcesResponse (Maybe TransitGatewayMulticastRegisteredGroupSources) Source #

Information about the transit gateway multicast group sources.

registerTransitGatewayMulticastGroupSourcesResponse_httpStatus :: Lens' RegisterTransitGatewayMulticastGroupSourcesResponse Int Source #

The response's http status code.