libZSservicesZSamazonka-apigatewayv2ZSamazonka-apigatewayv2
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ApiGatewayV2.CreateStage

Description

Creates a Stage for an API.

Synopsis

Creating a Request

data CreateStage Source #

Creates a new Stage resource to represent a stage.

See: newCreateStage smart constructor.

Constructors

CreateStage' 

Fields

Instances

Instances details
Eq CreateStage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateStage

Read CreateStage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateStage

Show CreateStage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateStage

Generic CreateStage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateStage

Associated Types

type Rep CreateStage :: Type -> Type #

NFData CreateStage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateStage

Methods

rnf :: CreateStage -> () #

Hashable CreateStage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateStage

ToJSON CreateStage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateStage

AWSRequest CreateStage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateStage

Associated Types

type AWSResponse CreateStage #

ToHeaders CreateStage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateStage

Methods

toHeaders :: CreateStage -> [Header] #

ToPath CreateStage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateStage

ToQuery CreateStage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateStage

type Rep CreateStage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateStage

type Rep CreateStage = D1 ('MetaData "CreateStage" "Amazonka.ApiGatewayV2.CreateStage" "libZSservicesZSamazonka-apigatewayv2ZSamazonka-apigatewayv2" 'False) (C1 ('MetaCons "CreateStage'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "routeSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text RouteSettings)))) :*: (S1 ('MetaSel ('Just "accessLogSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccessLogSettings)) :*: (S1 ('MetaSel ('Just "clientCertificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stageVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))) :*: ((S1 ('MetaSel ('Just "autoDeploy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "defaultRouteSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RouteSettings)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "apiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse CreateStage Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateStage

newCreateStage Source #

Create a value of CreateStage 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:deploymentId:CreateStage', createStage_deploymentId - The deployment identifier of the API stage.

$sel:routeSettings:CreateStage', createStage_routeSettings - Route settings for the stage, by routeKey.

$sel:accessLogSettings:CreateStage', createStage_accessLogSettings - Settings for logging access in this stage.

$sel:clientCertificateId:CreateStage', createStage_clientCertificateId - The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

$sel:stageVariables:CreateStage', createStage_stageVariables - A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

$sel:autoDeploy:CreateStage', createStage_autoDeploy - Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

$sel:defaultRouteSettings:CreateStage', createStage_defaultRouteSettings - The default route settings for the stage.

$sel:description:CreateStage', createStage_description - The description for the API stage.

$sel:tags:CreateStage', createStage_tags - The collection of tags. Each tag element is associated with a given resource.

$sel:apiId:CreateStage', createStage_apiId - The API identifier.

$sel:stageName:CreateStage', createStage_stageName - The name of the stage.

Request Lenses

createStage_deploymentId :: Lens' CreateStage (Maybe Text) Source #

The deployment identifier of the API stage.

createStage_routeSettings :: Lens' CreateStage (Maybe (HashMap Text RouteSettings)) Source #

Route settings for the stage, by routeKey.

createStage_accessLogSettings :: Lens' CreateStage (Maybe AccessLogSettings) Source #

Settings for logging access in this stage.

createStage_clientCertificateId :: Lens' CreateStage (Maybe Text) Source #

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

createStage_stageVariables :: Lens' CreateStage (Maybe (HashMap Text Text)) Source #

A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

createStage_autoDeploy :: Lens' CreateStage (Maybe Bool) Source #

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

createStage_defaultRouteSettings :: Lens' CreateStage (Maybe RouteSettings) Source #

The default route settings for the stage.

createStage_description :: Lens' CreateStage (Maybe Text) Source #

The description for the API stage.

createStage_tags :: Lens' CreateStage (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

Destructuring the Response

data CreateStageResponse Source #

See: newCreateStageResponse smart constructor.

Constructors

CreateStageResponse' 

Fields

Instances

Instances details
Eq CreateStageResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateStage

Read CreateStageResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateStage

Show CreateStageResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateStage

Generic CreateStageResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateStage

Associated Types

type Rep CreateStageResponse :: Type -> Type #

NFData CreateStageResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateStage

Methods

rnf :: CreateStageResponse -> () #

type Rep CreateStageResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateStage

type Rep CreateStageResponse = D1 ('MetaData "CreateStageResponse" "Amazonka.ApiGatewayV2.CreateStage" "libZSservicesZSamazonka-apigatewayv2ZSamazonka-apigatewayv2" 'False) (C1 ('MetaCons "CreateStageResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "lastDeploymentStatusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "routeSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text RouteSettings))))) :*: ((S1 ('MetaSel ('Just "accessLogSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccessLogSettings)) :*: S1 ('MetaSel ('Just "clientCertificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "stageVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "autoDeploy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: (((S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "defaultRouteSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RouteSettings))) :*: (S1 ('MetaSel ('Just "apiGatewayManaged") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "lastUpdatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newCreateStageResponse Source #

Create a value of CreateStageResponse 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:lastDeploymentStatusMessage:CreateStageResponse', createStageResponse_lastDeploymentStatusMessage - Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

$sel:deploymentId:CreateStage', createStageResponse_deploymentId - The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

$sel:routeSettings:CreateStage', createStageResponse_routeSettings - Route settings for the stage, by routeKey.

$sel:accessLogSettings:CreateStage', createStageResponse_accessLogSettings - Settings for logging access in this stage.

$sel:clientCertificateId:CreateStage', createStageResponse_clientCertificateId - The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

$sel:stageVariables:CreateStage', createStageResponse_stageVariables - A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

$sel:autoDeploy:CreateStage', createStageResponse_autoDeploy - Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

$sel:createdDate:CreateStageResponse', createStageResponse_createdDate - The timestamp when the stage was created.

$sel:defaultRouteSettings:CreateStage', createStageResponse_defaultRouteSettings - Default route settings for the stage.

$sel:apiGatewayManaged:CreateStageResponse', createStageResponse_apiGatewayManaged - Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

$sel:stageName:CreateStage', createStageResponse_stageName - The name of the stage.

$sel:lastUpdatedDate:CreateStageResponse', createStageResponse_lastUpdatedDate - The timestamp when the stage was last updated.

$sel:description:CreateStage', createStageResponse_description - The description of the stage.

$sel:tags:CreateStage', createStageResponse_tags - The collection of tags. Each tag element is associated with a given resource.

$sel:httpStatus:CreateStageResponse', createStageResponse_httpStatus - The response's http status code.

Response Lenses

createStageResponse_lastDeploymentStatusMessage :: Lens' CreateStageResponse (Maybe Text) Source #

Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

createStageResponse_deploymentId :: Lens' CreateStageResponse (Maybe Text) Source #

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

createStageResponse_clientCertificateId :: Lens' CreateStageResponse (Maybe Text) Source #

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

createStageResponse_stageVariables :: Lens' CreateStageResponse (Maybe (HashMap Text Text)) Source #

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

createStageResponse_autoDeploy :: Lens' CreateStageResponse (Maybe Bool) Source #

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

createStageResponse_createdDate :: Lens' CreateStageResponse (Maybe UTCTime) Source #

The timestamp when the stage was created.

createStageResponse_apiGatewayManaged :: Lens' CreateStageResponse (Maybe Bool) Source #

Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

createStageResponse_lastUpdatedDate :: Lens' CreateStageResponse (Maybe UTCTime) Source #

The timestamp when the stage was last updated.

createStageResponse_tags :: Lens' CreateStageResponse (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.