Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.APIGateway.CreateDeployment

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a Deployment resource, which makes a specified RestApi callable over the internet.

Synopsis

data CreateDeployment = CreateDeployment' {
- cacheClusterEnabled :: Maybe Bool
- cacheClusterSize :: Maybe CacheClusterSize
- canarySettings :: Maybe DeploymentCanarySettings
- description :: Maybe Text
- stageDescription :: Maybe Text
- stageName :: Maybe Text
- tracingEnabled :: Maybe Bool
- variables :: Maybe (HashMap Text Text)
- restApiId :: Text
}
newCreateDeployment :: Text -> CreateDeployment
createDeployment_cacheClusterEnabled :: Lens' CreateDeployment (Maybe Bool)
createDeployment_cacheClusterSize :: Lens' CreateDeployment (Maybe CacheClusterSize)
createDeployment_canarySettings :: Lens' CreateDeployment (Maybe DeploymentCanarySettings)
createDeployment_description :: Lens' CreateDeployment (Maybe Text)
createDeployment_stageDescription :: Lens' CreateDeployment (Maybe Text)
createDeployment_stageName :: Lens' CreateDeployment (Maybe Text)
createDeployment_tracingEnabled :: Lens' CreateDeployment (Maybe Bool)
createDeployment_variables :: Lens' CreateDeployment (Maybe (HashMap Text Text))
createDeployment_restApiId :: Lens' CreateDeployment Text
data Deployment = Deployment' {
- apiSummary :: Maybe (HashMap Text (HashMap Text MethodSnapshot))
- createdDate :: Maybe POSIX
- description :: Maybe Text
- id :: Maybe Text
}
newDeployment :: Deployment
deployment_apiSummary :: Lens' Deployment (Maybe (HashMap Text (HashMap Text MethodSnapshot)))
deployment_createdDate :: Lens' Deployment (Maybe UTCTime)
deployment_description :: Lens' Deployment (Maybe Text)
deployment_id :: Lens' Deployment (Maybe Text)

Creating a Request

data CreateDeployment Source #

Requests API Gateway to create a Deployment resource.

See: newCreateDeployment smart constructor.

Constructors

CreateDeployment'

Fields

cacheClusterEnabled :: Maybe Bool
Enables a cache cluster for the Stage resource specified in the input.
cacheClusterSize :: Maybe CacheClusterSize
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
canarySettings :: Maybe DeploymentCanarySettings
The input configuration for the canary deployment when the deployment is a canary release deployment.
description :: Maybe Text
The description for the Deployment resource to create.
stageDescription :: Maybe Text
The description of the Stage resource for the Deployment resource to create.
stageName :: Maybe Text
The name of the Stage resource for the Deployment resource to create.
tracingEnabled :: Maybe Bool
Specifies whether active tracing with X-ray is enabled for the Stage.
variables :: Maybe (HashMap Text Text)
A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
restApiId :: Text
The string identifier of the associated RestApi.

Instances

Instances details

ToJSON CreateDeployment Source #
Instance details Defined in Amazonka.APIGateway.CreateDeployment Methods toJSON :: CreateDeployment -> Value # toEncoding :: CreateDeployment -> Encoding # toJSONList :: [CreateDeployment] -> Value # toEncodingList :: [CreateDeployment] -> Encoding #
ToHeaders CreateDeployment Source #
Instance details Defined in Amazonka.APIGateway.CreateDeployment Methods toHeaders :: CreateDeployment -> [Header] #
ToPath CreateDeployment Source #
Instance details Defined in Amazonka.APIGateway.CreateDeployment Methods toPath :: CreateDeployment -> ByteString #
ToQuery CreateDeployment Source #
Instance details Defined in Amazonka.APIGateway.CreateDeployment Methods toQuery :: CreateDeployment -> QueryString #
AWSRequest CreateDeployment Source #
Instance details Defined in Amazonka.APIGateway.CreateDeployment Associated Types type AWSResponse CreateDeployment # Methods request :: (Service -> Service) -> CreateDeployment -> Request CreateDeployment # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDeployment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDeployment))) #
Generic CreateDeployment Source #
Instance details Defined in Amazonka.APIGateway.CreateDeployment Associated Types type Rep CreateDeployment :: Type -> Type # Methods from :: CreateDeployment -> Rep CreateDeployment x # to :: Rep CreateDeployment x -> CreateDeployment #
Read CreateDeployment Source #
Instance details Defined in Amazonka.APIGateway.CreateDeployment Methods readsPrec :: Int -> ReadS CreateDeployment # readList :: ReadS [CreateDeployment] # readPrec :: ReadPrec CreateDeployment # readListPrec :: ReadPrec [CreateDeployment] #
Show CreateDeployment Source #
Instance details Defined in Amazonka.APIGateway.CreateDeployment Methods showsPrec :: Int -> CreateDeployment -> ShowS # show :: CreateDeployment -> String # showList :: [CreateDeployment] -> ShowS #
NFData CreateDeployment Source #
Instance details Defined in Amazonka.APIGateway.CreateDeployment Methods rnf :: CreateDeployment -> () #
Eq CreateDeployment Source #
Instance details Defined in Amazonka.APIGateway.CreateDeployment Methods (==) :: CreateDeployment -> CreateDeployment -> Bool # (/=) :: CreateDeployment -> CreateDeployment -> Bool #
Hashable CreateDeployment Source #
Instance details Defined in Amazonka.APIGateway.CreateDeployment Methods hashWithSalt :: Int -> CreateDeployment -> Int # hash :: CreateDeployment -> Int #
type AWSResponse CreateDeployment Source #
Instance details Defined in Amazonka.APIGateway.CreateDeployment type AWSResponse CreateDeployment = Deployment
type Rep CreateDeployment Source #
Instance details Defined in Amazonka.APIGateway.CreateDeployment type Rep CreateDeployment = D1 ('MetaData "CreateDeployment" "Amazonka.APIGateway.CreateDeployment" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "CreateDeployment'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cacheClusterEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "cacheClusterSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CacheClusterSize))) :: (S1 ('MetaSel ('Just "canarySettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentCanarySettings)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "stageDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tracingEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "variables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateDeployment Source #

Arguments

:: Text	`CreateDeployment`
-> CreateDeployment

Create a value of CreateDeployment 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:

CreateDeployment, createDeployment_cacheClusterEnabled - Enables a cache cluster for the Stage resource specified in the input.

CreateDeployment, createDeployment_cacheClusterSize - The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

CreateDeployment, createDeployment_canarySettings - The input configuration for the canary deployment when the deployment is a canary release deployment.

CreateDeployment, createDeployment_description - The description for the Deployment resource to create.

$sel:stageDescription:CreateDeployment', createDeployment_stageDescription - The description of the Stage resource for the Deployment resource to create.

CreateDeployment, createDeployment_stageName - The name of the Stage resource for the Deployment resource to create.

CreateDeployment, createDeployment_tracingEnabled - Specifies whether active tracing with X-ray is enabled for the Stage.

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

CreateDeployment, createDeployment_restApiId - The string identifier of the associated RestApi.

Request Lenses

createDeployment_cacheClusterEnabled :: Lens' CreateDeployment (Maybe Bool) Source #

Enables a cache cluster for the Stage resource specified in the input.

createDeployment_cacheClusterSize :: Lens' CreateDeployment (Maybe CacheClusterSize) Source #

The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

createDeployment_canarySettings :: Lens' CreateDeployment (Maybe DeploymentCanarySettings) Source #

The input configuration for the canary deployment when the deployment is a canary release deployment.

createDeployment_description :: Lens' CreateDeployment (Maybe Text) Source #

The description for the Deployment resource to create.

createDeployment_stageDescription :: Lens' CreateDeployment (Maybe Text) Source #

The description of the Stage resource for the Deployment resource to create.

createDeployment_stageName :: Lens' CreateDeployment (Maybe Text) Source #

The name of the Stage resource for the Deployment resource to create.

createDeployment_tracingEnabled :: Lens' CreateDeployment (Maybe Bool) Source #

Specifies whether active tracing with X-ray is enabled for the Stage.

createDeployment_variables :: Lens' CreateDeployment (Maybe (HashMap Text Text)) Source #

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

createDeployment_restApiId :: Lens' CreateDeployment Text Source #

The string identifier of the associated RestApi.

Destructuring the Response

data Deployment Source #

An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.

See: newDeployment smart constructor.

Constructors

Deployment'
Fields apiSummary :: Maybe (HashMap Text (HashMap Text MethodSnapshot)) A summary of the RestApi at the date and time that the deployment resource was created. createdDate :: Maybe POSIX The date and time that the deployment resource was created. description :: Maybe Text The description for the deployment resource. id :: Maybe Text The identifier for the deployment resource.

Instances

Instances details

FromJSON Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods parseJSON :: Value -> Parser Deployment # parseJSONList :: Value -> Parser [Deployment] #
Generic Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Associated Types type Rep Deployment :: Type -> Type # Methods from :: Deployment -> Rep Deployment x # to :: Rep Deployment x -> Deployment #
Read Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods readsPrec :: Int -> ReadS Deployment # readList :: ReadS [Deployment] # readPrec :: ReadPrec Deployment # readListPrec :: ReadPrec [Deployment] #
Show Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods showsPrec :: Int -> Deployment -> ShowS # show :: Deployment -> String # showList :: [Deployment] -> ShowS #
NFData Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods rnf :: Deployment -> () #
Eq Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods (==) :: Deployment -> Deployment -> Bool # (/=) :: Deployment -> Deployment -> Bool #
Hashable Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods hashWithSalt :: Int -> Deployment -> Int # hash :: Deployment -> Int #
type Rep Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment type Rep Deployment = D1 ('MetaData "Deployment" "Amazonka.APIGateway.Types.Deployment" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Deployment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "apiSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text (HashMap Text MethodSnapshot)))) :: S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDeployment :: Deployment Source #

Create a value of Deployment 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:apiSummary:Deployment', deployment_apiSummary - A summary of the RestApi at the date and time that the deployment resource was created.

$sel:createdDate:Deployment', deployment_createdDate - The date and time that the deployment resource was created.

$sel:description:Deployment', deployment_description - The description for the deployment resource.

$sel:id:Deployment', deployment_id - The identifier for the deployment resource.

Response Lenses

deployment_apiSummary :: Lens' Deployment (Maybe (HashMap Text (HashMap Text MethodSnapshot))) Source #

A summary of the RestApi at the date and time that the deployment resource was created.

deployment_createdDate :: Lens' Deployment (Maybe UTCTime) Source #

The date and time that the deployment resource was created.

deployment_description :: Lens' Deployment (Maybe Text) Source #

The description for the deployment resource.

deployment_id :: Lens' Deployment (Maybe Text) Source #

The identifier for the deployment resource.