Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SecurityHub.Types.AwsApiGatewayV2ApiDetails

Description

Synopsis

data AwsApiGatewayV2ApiDetails = AwsApiGatewayV2ApiDetails' {
- apiId :: Maybe Text
- apiEndpoint :: Maybe Text
- createdDate :: Maybe Text
- name :: Maybe Text
- version :: Maybe Text
- apiKeySelectionExpression :: Maybe Text
- corsConfiguration :: Maybe AwsCorsConfiguration
- routeSelectionExpression :: Maybe Text
- description :: Maybe Text
- protocolType :: Maybe Text
}
newAwsApiGatewayV2ApiDetails :: AwsApiGatewayV2ApiDetails
awsApiGatewayV2ApiDetails_apiId :: Lens' AwsApiGatewayV2ApiDetails (Maybe Text)
awsApiGatewayV2ApiDetails_apiEndpoint :: Lens' AwsApiGatewayV2ApiDetails (Maybe Text)
awsApiGatewayV2ApiDetails_createdDate :: Lens' AwsApiGatewayV2ApiDetails (Maybe Text)
awsApiGatewayV2ApiDetails_name :: Lens' AwsApiGatewayV2ApiDetails (Maybe Text)
awsApiGatewayV2ApiDetails_version :: Lens' AwsApiGatewayV2ApiDetails (Maybe Text)
awsApiGatewayV2ApiDetails_apiKeySelectionExpression :: Lens' AwsApiGatewayV2ApiDetails (Maybe Text)
awsApiGatewayV2ApiDetails_corsConfiguration :: Lens' AwsApiGatewayV2ApiDetails (Maybe AwsCorsConfiguration)
awsApiGatewayV2ApiDetails_routeSelectionExpression :: Lens' AwsApiGatewayV2ApiDetails (Maybe Text)
awsApiGatewayV2ApiDetails_description :: Lens' AwsApiGatewayV2ApiDetails (Maybe Text)
awsApiGatewayV2ApiDetails_protocolType :: Lens' AwsApiGatewayV2ApiDetails (Maybe Text)

Documentation

data AwsApiGatewayV2ApiDetails Source #

Contains information about a version 2 API in Amazon API Gateway.

See: newAwsApiGatewayV2ApiDetails smart constructor.

Constructors

AwsApiGatewayV2ApiDetails'

Fields

apiId :: Maybe Text
The identifier of the API.
apiEndpoint :: Maybe Text
The URI of the API.
Uses the format <api-id>.execute-api.<region>.amazonaws.com
The stage name is typically appended to the URI to form a complete path to a deployed API stage.
createdDate :: Maybe Text
Indicates when the API was created.
Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.
name :: Maybe Text
The name of the API.
version :: Maybe Text
The version identifier for the API.
apiKeySelectionExpression :: Maybe Text
An API key selection expression. Supported only for WebSocket APIs.
corsConfiguration :: Maybe AwsCorsConfiguration
A cross-origin resource sharing (CORS) configuration. Supported only for HTTP APIs.
routeSelectionExpression :: Maybe Text
The route selection expression for the API.
For HTTP APIs, must be ${request.method} ${request.path}. This is the default value for HTTP APIs.
For WebSocket APIs, there is no default value.
description :: Maybe Text
A description of the API.
protocolType :: Maybe Text
The API protocol for the API.
Valid values: WEBSOCKET | HTTP

Instances

Instances details

Eq AwsApiGatewayV2ApiDetails Source #
Instance details Defined in Amazonka.SecurityHub.Types.AwsApiGatewayV2ApiDetails Methods (==) :: AwsApiGatewayV2ApiDetails -> AwsApiGatewayV2ApiDetails -> Bool # (/=) :: AwsApiGatewayV2ApiDetails -> AwsApiGatewayV2ApiDetails -> Bool #
Read AwsApiGatewayV2ApiDetails Source #
Instance details Defined in Amazonka.SecurityHub.Types.AwsApiGatewayV2ApiDetails Methods readsPrec :: Int -> ReadS AwsApiGatewayV2ApiDetails # readList :: ReadS [AwsApiGatewayV2ApiDetails] # readPrec :: ReadPrec AwsApiGatewayV2ApiDetails # readListPrec :: ReadPrec [AwsApiGatewayV2ApiDetails] #
Show AwsApiGatewayV2ApiDetails Source #
Instance details Defined in Amazonka.SecurityHub.Types.AwsApiGatewayV2ApiDetails Methods showsPrec :: Int -> AwsApiGatewayV2ApiDetails -> ShowS # show :: AwsApiGatewayV2ApiDetails -> String # showList :: [AwsApiGatewayV2ApiDetails] -> ShowS #
Generic AwsApiGatewayV2ApiDetails Source #
Instance details Defined in Amazonka.SecurityHub.Types.AwsApiGatewayV2ApiDetails Associated Types type Rep AwsApiGatewayV2ApiDetails :: Type -> Type # Methods from :: AwsApiGatewayV2ApiDetails -> Rep AwsApiGatewayV2ApiDetails x # to :: Rep AwsApiGatewayV2ApiDetails x -> AwsApiGatewayV2ApiDetails #
NFData AwsApiGatewayV2ApiDetails Source #
Instance details Defined in Amazonka.SecurityHub.Types.AwsApiGatewayV2ApiDetails Methods rnf :: AwsApiGatewayV2ApiDetails -> () #
Hashable AwsApiGatewayV2ApiDetails Source #
Instance details Defined in Amazonka.SecurityHub.Types.AwsApiGatewayV2ApiDetails Methods hashWithSalt :: Int -> AwsApiGatewayV2ApiDetails -> Int # hash :: AwsApiGatewayV2ApiDetails -> Int #
ToJSON AwsApiGatewayV2ApiDetails Source #
Instance details Defined in Amazonka.SecurityHub.Types.AwsApiGatewayV2ApiDetails Methods toJSON :: AwsApiGatewayV2ApiDetails -> Value # toEncoding :: AwsApiGatewayV2ApiDetails -> Encoding # toJSONList :: [AwsApiGatewayV2ApiDetails] -> Value # toEncodingList :: [AwsApiGatewayV2ApiDetails] -> Encoding #
FromJSON AwsApiGatewayV2ApiDetails Source #
Instance details Defined in Amazonka.SecurityHub.Types.AwsApiGatewayV2ApiDetails Methods parseJSON :: Value -> Parser AwsApiGatewayV2ApiDetails # parseJSONList :: Value -> Parser [AwsApiGatewayV2ApiDetails] #
type Rep AwsApiGatewayV2ApiDetails Source #
Instance details Defined in Amazonka.SecurityHub.Types.AwsApiGatewayV2ApiDetails type Rep AwsApiGatewayV2ApiDetails = D1 ('MetaData "AwsApiGatewayV2ApiDetails" "Amazonka.SecurityHub.Types.AwsApiGatewayV2ApiDetails" "libZSservicesZSamazonka-securityhubZSamazonka-securityhub" 'False) (C1 ('MetaCons "AwsApiGatewayV2ApiDetails'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "apiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "apiEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "version") '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 AwsCorsConfiguration))) :: (S1 ('MetaSel ('Just "routeSelectionExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "protocolType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newAwsApiGatewayV2ApiDetails :: AwsApiGatewayV2ApiDetails Source #

Create a value of AwsApiGatewayV2ApiDetails 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:apiId:AwsApiGatewayV2ApiDetails', awsApiGatewayV2ApiDetails_apiId - The identifier of the API.

$sel:apiEndpoint:AwsApiGatewayV2ApiDetails', awsApiGatewayV2ApiDetails_apiEndpoint - The URI of the API.

Uses the format <api-id>.execute-api.<region>.amazonaws.com

The stage name is typically appended to the URI to form a complete path to a deployed API stage.

$sel:createdDate:AwsApiGatewayV2ApiDetails', awsApiGatewayV2ApiDetails_createdDate - Indicates when the API was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

$sel:name:AwsApiGatewayV2ApiDetails', awsApiGatewayV2ApiDetails_name - The name of the API.

$sel:version:AwsApiGatewayV2ApiDetails', awsApiGatewayV2ApiDetails_version - The version identifier for the API.

$sel:apiKeySelectionExpression:AwsApiGatewayV2ApiDetails', awsApiGatewayV2ApiDetails_apiKeySelectionExpression - An API key selection expression. Supported only for WebSocket APIs.

$sel:corsConfiguration:AwsApiGatewayV2ApiDetails', awsApiGatewayV2ApiDetails_corsConfiguration - A cross-origin resource sharing (CORS) configuration. Supported only for HTTP APIs.

$sel:routeSelectionExpression:AwsApiGatewayV2ApiDetails', awsApiGatewayV2ApiDetails_routeSelectionExpression - The route selection expression for the API.

For HTTP APIs, must be ${request.method} ${request.path}. This is the default value for HTTP APIs.

For WebSocket APIs, there is no default value.

$sel:description:AwsApiGatewayV2ApiDetails', awsApiGatewayV2ApiDetails_description - A description of the API.

$sel:protocolType:AwsApiGatewayV2ApiDetails', awsApiGatewayV2ApiDetails_protocolType - The API protocol for the API.

Valid values: WEBSOCKET | HTTP

awsApiGatewayV2ApiDetails_apiId :: Lens' AwsApiGatewayV2ApiDetails (Maybe Text) Source #

The identifier of the API.

awsApiGatewayV2ApiDetails_apiEndpoint :: Lens' AwsApiGatewayV2ApiDetails (Maybe Text) Source #

The URI of the API.

Uses the format <api-id>.execute-api.<region>.amazonaws.com

The stage name is typically appended to the URI to form a complete path to a deployed API stage.

awsApiGatewayV2ApiDetails_createdDate :: Lens' AwsApiGatewayV2ApiDetails (Maybe Text) Source #

Indicates when the API was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

awsApiGatewayV2ApiDetails_name :: Lens' AwsApiGatewayV2ApiDetails (Maybe Text) Source #

The name of the API.

awsApiGatewayV2ApiDetails_version :: Lens' AwsApiGatewayV2ApiDetails (Maybe Text) Source #

The version identifier for the API.

awsApiGatewayV2ApiDetails_apiKeySelectionExpression :: Lens' AwsApiGatewayV2ApiDetails (Maybe Text) Source #

An API key selection expression. Supported only for WebSocket APIs.

awsApiGatewayV2ApiDetails_corsConfiguration :: Lens' AwsApiGatewayV2ApiDetails (Maybe AwsCorsConfiguration) Source #

A cross-origin resource sharing (CORS) configuration. Supported only for HTTP APIs.

awsApiGatewayV2ApiDetails_routeSelectionExpression :: Lens' AwsApiGatewayV2ApiDetails (Maybe Text) Source #

The route selection expression for the API.

For HTTP APIs, must be ${request.method} ${request.path}. This is the default value for HTTP APIs.

For WebSocket APIs, there is no default value.

awsApiGatewayV2ApiDetails_description :: Lens' AwsApiGatewayV2ApiDetails (Maybe Text) Source #

A description of the API.

awsApiGatewayV2ApiDetails_protocolType :: Lens' AwsApiGatewayV2ApiDetails (Maybe Text) Source #

The API protocol for the API.

Valid values: WEBSOCKET | HTTP