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.ExportTransitGatewayRoutes

Description

Exports routes from the specified transit gateway route table to the specified S3 bucket. By default, all routes are exported. Alternatively, you can filter by CIDR range.

The routes are saved to the specified bucket in a JSON file. For more information, see Export Route Tables to Amazon S3 in Transit Gateways.

Synopsis

Creating a Request

data ExportTransitGatewayRoutes Source #

See: newExportTransitGatewayRoutes smart constructor.

Constructors

ExportTransitGatewayRoutes' 

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.

  • filters :: Maybe [Filter]

    One or more filters. The possible values are:

    • attachment.transit-gateway-attachment-id - The id of the transit gateway attachment.
    • attachment.resource-id - The resource id of the transit gateway attachment.
    • route-search.exact-match - The exact match of the specified filter.
    • route-search.longest-prefix-match - The longest prefix that matches the route.
    • route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
    • route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
    • state - The state of the route (active | blackhole).
    • transit-gateway-route-destination-cidr-block - The CIDR range.
    • type - The type of route (propagated | static).
  • transitGatewayRouteTableId :: Text

    The ID of the route table.

  • s3Bucket :: Text

    The name of the S3 bucket.

Instances

Instances details
ToHeaders ExportTransitGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.ExportTransitGatewayRoutes

Methods

toHeaders :: ExportTransitGatewayRoutes -> [Header] #

ToPath ExportTransitGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.ExportTransitGatewayRoutes

Methods

toPath :: ExportTransitGatewayRoutes -> ByteString #

ToQuery ExportTransitGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.ExportTransitGatewayRoutes

Methods

toQuery :: ExportTransitGatewayRoutes -> QueryString #

AWSRequest ExportTransitGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.ExportTransitGatewayRoutes

Associated Types

type AWSResponse ExportTransitGatewayRoutes #

Methods

request :: (Service -> Service) -> ExportTransitGatewayRoutes -> Request ExportTransitGatewayRoutes #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ExportTransitGatewayRoutes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ExportTransitGatewayRoutes))) #

Generic ExportTransitGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.ExportTransitGatewayRoutes

Associated Types

type Rep ExportTransitGatewayRoutes :: Type -> Type #

Methods

from :: ExportTransitGatewayRoutes -> Rep ExportTransitGatewayRoutes x #

to :: Rep ExportTransitGatewayRoutes x -> ExportTransitGatewayRoutes #

Read ExportTransitGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.ExportTransitGatewayRoutes

Methods

readsPrec :: Int -> ReadS ExportTransitGatewayRoutes #

readList :: ReadS [ExportTransitGatewayRoutes] #

readPrec :: ReadPrec ExportTransitGatewayRoutes #

readListPrec :: ReadPrec [ExportTransitGatewayRoutes] #

Show ExportTransitGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.ExportTransitGatewayRoutes

Methods

showsPrec :: Int -> ExportTransitGatewayRoutes -> ShowS #

show :: ExportTransitGatewayRoutes -> String #

showList :: [ExportTransitGatewayRoutes] -> ShowS #

NFData ExportTransitGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.ExportTransitGatewayRoutes

Methods

rnf :: ExportTransitGatewayRoutes -> () #

Eq ExportTransitGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.ExportTransitGatewayRoutes

Methods

(==) :: ExportTransitGatewayRoutes -> ExportTransitGatewayRoutes -> Bool #

(/=) :: ExportTransitGatewayRoutes -> ExportTransitGatewayRoutes -> Bool #

Hashable ExportTransitGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.ExportTransitGatewayRoutes

Methods

hashWithSalt :: Int -> ExportTransitGatewayRoutes -> Int #

hash :: ExportTransitGatewayRoutes -> Int #

type AWSResponse ExportTransitGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.ExportTransitGatewayRoutes

type AWSResponse ExportTransitGatewayRoutes = ExportTransitGatewayRoutesResponse
type Rep ExportTransitGatewayRoutes Source # 
Instance details

Defined in Amazonka.EC2.ExportTransitGatewayRoutes

type Rep ExportTransitGatewayRoutes = D1 ('MetaData "ExportTransitGatewayRoutes" "Amazonka.EC2.ExportTransitGatewayRoutes" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ExportTransitGatewayRoutes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :*: (S1 ('MetaSel ('Just "transitGatewayRouteTableId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "s3Bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newExportTransitGatewayRoutes Source #

Arguments

:: Text

ExportTransitGatewayRoutes

-> Text

ExportTransitGatewayRoutes

-> ExportTransitGatewayRoutes 

Create a value of ExportTransitGatewayRoutes 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:ExportTransitGatewayRoutes', exportTransitGatewayRoutes_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.

$sel:filters:ExportTransitGatewayRoutes', exportTransitGatewayRoutes_filters - One or more filters. The possible values are:

  • attachment.transit-gateway-attachment-id - The id of the transit gateway attachment.
  • attachment.resource-id - The resource id of the transit gateway attachment.
  • route-search.exact-match - The exact match of the specified filter.
  • route-search.longest-prefix-match - The longest prefix that matches the route.
  • route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
  • route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
  • state - The state of the route (active | blackhole).
  • transit-gateway-route-destination-cidr-block - The CIDR range.
  • type - The type of route (propagated | static).

ExportTransitGatewayRoutes, exportTransitGatewayRoutes_transitGatewayRouteTableId - The ID of the route table.

ExportTransitGatewayRoutes, exportTransitGatewayRoutes_s3Bucket - The name of the S3 bucket.

Request Lenses

exportTransitGatewayRoutes_dryRun :: Lens' ExportTransitGatewayRoutes (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.

exportTransitGatewayRoutes_filters :: Lens' ExportTransitGatewayRoutes (Maybe [Filter]) Source #

One or more filters. The possible values are:

  • attachment.transit-gateway-attachment-id - The id of the transit gateway attachment.
  • attachment.resource-id - The resource id of the transit gateway attachment.
  • route-search.exact-match - The exact match of the specified filter.
  • route-search.longest-prefix-match - The longest prefix that matches the route.
  • route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
  • route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
  • state - The state of the route (active | blackhole).
  • transit-gateway-route-destination-cidr-block - The CIDR range.
  • type - The type of route (propagated | static).

exportTransitGatewayRoutes_transitGatewayRouteTableId :: Lens' ExportTransitGatewayRoutes Text Source #

The ID of the route table.

exportTransitGatewayRoutes_s3Bucket :: Lens' ExportTransitGatewayRoutes Text Source #

The name of the S3 bucket.

Destructuring the Response

data ExportTransitGatewayRoutesResponse Source #

See: newExportTransitGatewayRoutesResponse smart constructor.

Constructors

ExportTransitGatewayRoutesResponse' 

Fields

  • s3Location :: Maybe Text

    The URL of the exported file in Amazon S3. For example, s3://bucket_name/VPCTransitGateway/TransitGatewayRouteTables/file_name.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ExportTransitGatewayRoutesResponse Source # 
Instance details

Defined in Amazonka.EC2.ExportTransitGatewayRoutes

Associated Types

type Rep ExportTransitGatewayRoutesResponse :: Type -> Type #

Methods

from :: ExportTransitGatewayRoutesResponse -> Rep ExportTransitGatewayRoutesResponse x #

to :: Rep ExportTransitGatewayRoutesResponse x -> ExportTransitGatewayRoutesResponse #

Read ExportTransitGatewayRoutesResponse Source # 
Instance details

Defined in Amazonka.EC2.ExportTransitGatewayRoutes

Methods

readsPrec :: Int -> ReadS ExportTransitGatewayRoutesResponse #

readList :: ReadS [ExportTransitGatewayRoutesResponse] #

readPrec :: ReadPrec ExportTransitGatewayRoutesResponse #

readListPrec :: ReadPrec [ExportTransitGatewayRoutesResponse] #

Show ExportTransitGatewayRoutesResponse Source # 
Instance details

Defined in Amazonka.EC2.ExportTransitGatewayRoutes

Methods

showsPrec :: Int -> ExportTransitGatewayRoutesResponse -> ShowS #

show :: ExportTransitGatewayRoutesResponse -> String #

showList :: [ExportTransitGatewayRoutesResponse] -> ShowS #

NFData ExportTransitGatewayRoutesResponse Source # 
Instance details

Defined in Amazonka.EC2.ExportTransitGatewayRoutes

Methods

rnf :: ExportTransitGatewayRoutesResponse -> () #

Eq ExportTransitGatewayRoutesResponse Source # 
Instance details

Defined in Amazonka.EC2.ExportTransitGatewayRoutes

Methods

(==) :: ExportTransitGatewayRoutesResponse -> ExportTransitGatewayRoutesResponse -> Bool #

(/=) :: ExportTransitGatewayRoutesResponse -> ExportTransitGatewayRoutesResponse -> Bool #

type Rep ExportTransitGatewayRoutesResponse Source # 
Instance details

Defined in Amazonka.EC2.ExportTransitGatewayRoutes

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

newExportTransitGatewayRoutesResponse Source #

Arguments

:: Int

$sel:httpStatus:ExportTransitGatewayRoutesResponse'

-> ExportTransitGatewayRoutesResponse 

Create a value of ExportTransitGatewayRoutesResponse 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:s3Location:ExportTransitGatewayRoutesResponse', exportTransitGatewayRoutesResponse_s3Location - The URL of the exported file in Amazon S3. For example, s3://bucket_name/VPCTransitGateway/TransitGatewayRouteTables/file_name.

$sel:httpStatus:ExportTransitGatewayRoutesResponse', exportTransitGatewayRoutesResponse_httpStatus - The response's http status code.

Response Lenses

exportTransitGatewayRoutesResponse_s3Location :: Lens' ExportTransitGatewayRoutesResponse (Maybe Text) Source #

The URL of the exported file in Amazon S3. For example, s3://bucket_name/VPCTransitGateway/TransitGatewayRouteTables/file_name.

exportTransitGatewayRoutesResponse_httpStatus :: Lens' ExportTransitGatewayRoutesResponse Int Source #

The response's http status code.