Amazonka.APIGateway.Types.EndpointConfiguration

Documentation

data EndpointConfiguration

The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.

See: newEndpointConfiguration smart constructor.

Constructors

EndpointConfiguration'

Fields

• types :: Maybe [EndpointType]

  A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE.

• vpcEndpointIds :: Maybe [Text]

  A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type.

Instances

FromJSON EndpointConfiguration

Defined in Amazonka.APIGateway.Types.EndpointConfiguration

Methods

parseJSON :: Value -> Parser EndpointConfiguration

parseJSONList :: Value -> Parser [EndpointConfiguration]

ToJSON EndpointConfiguration

Defined in Amazonka.APIGateway.Types.EndpointConfiguration

Methods

toJSON :: EndpointConfiguration -> Value

toEncoding :: EndpointConfiguration -> Encoding

toJSONList :: [EndpointConfiguration] -> Value

toEncodingList :: [EndpointConfiguration] -> Encoding

Generic EndpointConfiguration

Defined in Amazonka.APIGateway.Types.EndpointConfiguration

Associated Types

type Rep EndpointConfiguration :: Type -> Type

Methods

from :: EndpointConfiguration -> Rep EndpointConfiguration x

to :: Rep EndpointConfiguration x -> EndpointConfiguration

Read EndpointConfiguration

Defined in Amazonka.APIGateway.Types.EndpointConfiguration

Methods

readsPrec :: Int -> ReadS EndpointConfiguration

readList :: ReadS [EndpointConfiguration]

readPrec :: ReadPrec EndpointConfiguration

readListPrec :: ReadPrec [EndpointConfiguration]

Show EndpointConfiguration

Defined in Amazonka.APIGateway.Types.EndpointConfiguration

Methods

showsPrec :: Int -> EndpointConfiguration -> ShowS

show :: EndpointConfiguration -> String

showList :: [EndpointConfiguration] -> ShowS

NFData EndpointConfiguration

Defined in Amazonka.APIGateway.Types.EndpointConfiguration

Methods

rnf :: EndpointConfiguration -> ()

Eq EndpointConfiguration

Defined in Amazonka.APIGateway.Types.EndpointConfiguration

Methods

(==) :: EndpointConfiguration -> EndpointConfiguration -> Bool

(/=) :: EndpointConfiguration -> EndpointConfiguration -> Bool

Hashable EndpointConfiguration

Defined in Amazonka.APIGateway.Types.EndpointConfiguration

Methods

hashWithSalt :: Int -> EndpointConfiguration -> Int

hash :: EndpointConfiguration -> Int

type Rep EndpointConfiguration

Defined in Amazonka.APIGateway.Types.EndpointConfiguration

type Rep EndpointConfiguration = D1 ('MetaData "EndpointConfiguration" "Amazonka.APIGateway.Types.EndpointConfiguration" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "EndpointConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "types") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EndpointType])) :*: S1 ('MetaSel ('Just "vpcEndpointIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))

newEndpointConfiguration :: EndpointConfiguration

Create a value of EndpointConfiguration 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:types:EndpointConfiguration', endpointConfiguration_types - A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE.

$sel:vpcEndpointIds:EndpointConfiguration', endpointConfiguration_vpcEndpointIds - A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type.

endpointConfiguration_types :: Lens' EndpointConfiguration (Maybe [EndpointType])

A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE.

endpointConfiguration_vpcEndpointIds :: Lens' EndpointConfiguration (Maybe [Text])

A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type.