Network.AWS.APIGateway.CreateDeployment

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

See: AWS API Reference for CreateDeployment.

Creating a Request

createDeployment

Arguments

:: Text

cdRestAPIId

-> Text

cdStageName

-> CreateDeployment

Creates a value of CreateDeployment with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cdStageDescription
• cdVariables
• cdCacheClusterSize
• cdCacheClusterEnabled
• cdDescription
• cdRestAPIId
• cdStageName

data CreateDeployment

Requests Amazon API Gateway to create a Deployment resource.

See: createDeployment smart constructor.

Instances

Eq CreateDeployment

Data CreateDeployment

Read CreateDeployment

Show CreateDeployment

Generic CreateDeployment

ToJSON CreateDeployment

AWSRequest CreateDeployment

ToPath CreateDeployment

ToHeaders CreateDeployment

ToQuery CreateDeployment

type Rep CreateDeployment

type Rs CreateDeployment = Deployment

Request Lenses

cdStageDescription :: Lens' CreateDeployment (Maybe Text)

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

cdVariables :: Lens' CreateDeployment (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 alphabetic characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+

cdCacheClusterSize :: Lens' CreateDeployment (Maybe CacheClusterSize)

Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.

cdCacheClusterEnabled :: Lens' CreateDeployment (Maybe Bool)

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

cdDescription :: Lens' CreateDeployment (Maybe Text)

The description for the Deployment resource to create.

cdRestAPIId :: Lens' CreateDeployment Text

The RestApi resource identifier for the Deployment resource to create.

cdStageName :: Lens' CreateDeployment Text

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

Destructuring the Response

deployment :: Deployment

Creates a value of Deployment with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dApiSummary
• dCreatedDate
• dId
• dDescription

data Deployment

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: deployment smart constructor.

Instances

Eq Deployment

Data Deployment

Read Deployment

Show Deployment

Generic Deployment

FromJSON Deployment

type Rep Deployment

Response Lenses

dApiSummary :: Lens' Deployment (HashMap Text (HashMap Text MethodSnapshot))

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

dCreatedDate :: Lens' Deployment (Maybe UTCTime)

The date and time that the deployment resource was created.

dId :: Lens' Deployment (Maybe Text)

The identifier for the deployment resource.

dDescription :: Lens' Deployment (Maybe Text)

The description for the deployment resource.