Amazonka.ApiGatewayV2.Types.Api

Documentation

data Api

Represents an API.

See: newApi smart constructor.

Constructors

Api'

Fields

• apiEndpoint :: Maybe Text

  The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

• apiGatewayManaged :: Maybe Bool

  Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

• apiId :: Maybe Text

  The API ID.

• apiKeySelectionExpression :: Maybe Text

  An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

• corsConfiguration :: Maybe Cors

  A CORS configuration. Supported only for HTTP APIs.

• createdDate :: Maybe ISO8601

  The timestamp when the API was created.

• description :: Maybe Text

  The description of the API.

• disableExecuteApiEndpoint :: Maybe Bool

  Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

• disableSchemaValidation :: Maybe Bool

  Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

• importInfo :: Maybe [Text]

  The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

• tags :: Maybe (HashMap Text Text)

  A collection of tags associated with the API.

• version :: Maybe Text

  A version identifier for the API.

• warnings :: Maybe [Text]

  The warning messages reported when failonwarnings is turned on during API import.

• routeSelectionExpression :: Text

  The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

• name :: Text

  The name of the API.

• protocolType :: ProtocolType

  The API protocol.

Instances

FromJSON Api

Defined in Amazonka.ApiGatewayV2.Types.Api

Methods

parseJSON :: Value -> Parser Api

parseJSONList :: Value -> Parser [Api]

Generic Api

Defined in Amazonka.ApiGatewayV2.Types.Api

Associated Types

type Rep Api :: Type -> Type

Methods

from :: Api -> Rep Api x

to :: Rep Api x -> Api

Read Api

Defined in Amazonka.ApiGatewayV2.Types.Api

Methods

readsPrec :: Int -> ReadS Api

readList :: ReadS [Api]

readPrec :: ReadPrec Api

readListPrec :: ReadPrec [Api]

Show Api

Defined in Amazonka.ApiGatewayV2.Types.Api

Methods

showsPrec :: Int -> Api -> ShowS

show :: Api -> String

showList :: [Api] -> ShowS

NFData Api

Defined in Amazonka.ApiGatewayV2.Types.Api

Methods

rnf :: Api -> ()

Eq Api

Defined in Amazonka.ApiGatewayV2.Types.Api

Methods

(==) :: Api -> Api -> Bool

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

Hashable Api

Defined in Amazonka.ApiGatewayV2.Types.Api

Methods

hashWithSalt :: Int -> Api -> Int

hash :: Api -> Int

type Rep Api

Defined in Amazonka.ApiGatewayV2.Types.Api

type Rep Api = D1 ('MetaData "Api" "Amazonka.ApiGatewayV2.Types.Api" "amazonka-apigatewayv2-2.0-4MZ8oueToeLOWomgegceF" 'False) (C1 ('MetaCons "Api'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "apiEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "apiGatewayManaged") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "apiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "apiKeySelectionExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "corsConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Cors)) :*: S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "disableExecuteApiEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: (((S1 ('MetaSel ('Just "disableSchemaValidation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "importInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "warnings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "routeSelectionExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "protocolType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ProtocolType))))))

newApi

Arguments

:: Text

$sel:routeSelectionExpression:Api'

-> Text

$sel:name:Api'

-> ProtocolType

$sel:protocolType:Api'

-> Api

Create a value of Api 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:apiEndpoint:Api', api_apiEndpoint - The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

$sel:apiGatewayManaged:Api', api_apiGatewayManaged - Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

$sel:apiId:Api', api_apiId - The API ID.

$sel:apiKeySelectionExpression:Api', api_apiKeySelectionExpression - An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

$sel:corsConfiguration:Api', api_corsConfiguration - A CORS configuration. Supported only for HTTP APIs.

$sel:createdDate:Api', api_createdDate - The timestamp when the API was created.

$sel:description:Api', api_description - The description of the API.

$sel:disableExecuteApiEndpoint:Api', api_disableExecuteApiEndpoint - Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

$sel:disableSchemaValidation:Api', api_disableSchemaValidation - Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

$sel:importInfo:Api', api_importInfo - The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

$sel:tags:Api', api_tags - A collection of tags associated with the API.

$sel:version:Api', api_version - A version identifier for the API.

$sel:warnings:Api', api_warnings - The warning messages reported when failonwarnings is turned on during API import.

$sel:routeSelectionExpression:Api', api_routeSelectionExpression - The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

$sel:name:Api', api_name - The name of the API.

$sel:protocolType:Api', api_protocolType - The API protocol.

api_apiEndpoint :: Lens' Api (Maybe Text)

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

api_apiGatewayManaged :: Lens' Api (Maybe Bool)

Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

api_apiId :: Lens' Api (Maybe Text)

The API ID.

api_apiKeySelectionExpression :: Lens' Api (Maybe Text)

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

api_corsConfiguration :: Lens' Api (Maybe Cors)

A CORS configuration. Supported only for HTTP APIs.

api_createdDate :: Lens' Api (Maybe UTCTime)

The timestamp when the API was created.

api_description :: Lens' Api (Maybe Text)

The description of the API.

api_disableExecuteApiEndpoint :: Lens' Api (Maybe Bool)

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

api_disableSchemaValidation :: Lens' Api (Maybe Bool)

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

api_importInfo :: Lens' Api (Maybe [Text])

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

api_tags :: Lens' Api (Maybe (HashMap Text Text))

A collection of tags associated with the API.

api_version :: Lens' Api (Maybe Text)

A version identifier for the API.

api_warnings :: Lens' Api (Maybe [Text])

The warning messages reported when failonwarnings is turned on during API import.

api_routeSelectionExpression :: Lens' Api Text

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

api_name :: Lens' Api Text

The name of the API.

api_protocolType :: Lens' Api ProtocolType

The API protocol.