Network.AWS.APIGateway.CreateDeployment

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

Creating a Request

createDeployment

Arguments

:: Text

cdRestAPIId

-> 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 - The description of the Stage resource for the Deployment resource to create.
• cdVariables - 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-._~:/?#&=,]+ .
• cdCacheClusterSize - Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.
• cdCanarySettings - The input configuration for the canary deployment when the deployment is a canary release deployment.
• cdCacheClusterEnabled - Enables a cache cluster for the Stage resource specified in the input.
• cdStageName - The name of the Stage resource for the Deployment resource to create.
• cdDescription - The description for the Deployment resource to create.
• cdRestAPIId - [Required] The string identifier of the associated RestApi .

data CreateDeployment

Requests API Gateway to create a Deployment resource.

See: createDeployment smart constructor.

Instances

Eq CreateDeployment

Methods

(==) :: CreateDeployment -> CreateDeployment -> Bool

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

Data CreateDeployment

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateDeployment -> c CreateDeployment

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateDeployment

toConstr :: CreateDeployment -> Constr

dataTypeOf :: CreateDeployment -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateDeployment)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateDeployment)

gmapT :: (forall b. Data b => b -> b) -> CreateDeployment -> CreateDeployment

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateDeployment -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateDeployment -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateDeployment -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateDeployment -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateDeployment -> m CreateDeployment

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateDeployment -> m CreateDeployment

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateDeployment -> m CreateDeployment

Read CreateDeployment

Methods

readsPrec :: Int -> ReadS CreateDeployment

readList :: ReadS [CreateDeployment]

readPrec :: ReadPrec CreateDeployment

readListPrec :: ReadPrec [CreateDeployment]

Show CreateDeployment

Methods

showsPrec :: Int -> CreateDeployment -> ShowS

show :: CreateDeployment -> String

showList :: [CreateDeployment] -> ShowS

Generic CreateDeployment

Associated Types

type Rep CreateDeployment :: * -> *

Methods

from :: CreateDeployment -> Rep CreateDeployment x

to :: Rep CreateDeployment x -> CreateDeployment

Hashable CreateDeployment

Methods

hashWithSalt :: Int -> CreateDeployment -> Int

hash :: CreateDeployment -> Int

ToJSON CreateDeployment

Methods

toJSON :: CreateDeployment -> Value

toEncoding :: CreateDeployment -> Encoding

toJSONList :: [CreateDeployment] -> Value

toEncodingList :: [CreateDeployment] -> Encoding

NFData CreateDeployment

Methods

rnf :: CreateDeployment -> ()

AWSRequest CreateDeployment

Associated Types

type Rs CreateDeployment :: *

Methods

request :: CreateDeployment -> Request CreateDeployment

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * CreateDeployment -> ClientResponse -> m (Response CreateDeployment)

ToHeaders CreateDeployment

Methods

toHeaders :: CreateDeployment -> [Header]

ToPath CreateDeployment

Methods

toPath :: CreateDeployment -> ByteString

ToQuery CreateDeployment

Methods

toQuery :: CreateDeployment -> QueryString

type Rep CreateDeployment

type Rep CreateDeployment = D1 * (MetaData "CreateDeployment" "Network.AWS.APIGateway.CreateDeployment" "amazonka-apigateway-1.6.0-JJ9NJtNe0aRBcVRYpJCEA2" False) (C1 * (MetaCons "CreateDeployment'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cdStageDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cdVariables") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cdCacheClusterSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe CacheClusterSize))) (S1 * (MetaSel (Just Symbol "_cdCanarySettings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DeploymentCanarySettings))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cdCacheClusterEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_cdStageName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cdDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cdRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

type Rs 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 alphanumeric and underscore 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.

cdCanarySettings :: Lens' CreateDeployment (Maybe DeploymentCanarySettings)

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

cdCacheClusterEnabled :: Lens' CreateDeployment (Maybe Bool)

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

cdStageName :: Lens' CreateDeployment (Maybe Text)

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

cdDescription :: Lens' CreateDeployment (Maybe Text)

The description for the Deployment resource to create.

cdRestAPIId :: Lens' CreateDeployment Text

Required

The string identifier of the associated RestApi .

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 - A summary of the RestApi at the date and time that the deployment resource was created.
• dCreatedDate - The date and time that the deployment resource was created.
• dId - The identifier for the deployment resource.
• dDescription - The description for the deployment resource.

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.

To create a deployment, call POST on the Deployments resource of a RestApi . To view, update, or delete a deployment, call GET , PATCH , or DELETE on the specified deployment resource (restapis{restapi_id}deployments{deployment_id} ).RestApi , Deployments , Stage , AWS CLI , AWS SDKs

See: deployment smart constructor.

Instances

Eq Deployment

Methods

(==) :: Deployment -> Deployment -> Bool

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

Data Deployment

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Deployment -> c Deployment

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Deployment

toConstr :: Deployment -> Constr

dataTypeOf :: Deployment -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Deployment)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Deployment)

gmapT :: (forall b. Data b => b -> b) -> Deployment -> Deployment

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Deployment -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Deployment -> r

gmapQ :: (forall d. Data d => d -> u) -> Deployment -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Deployment -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Deployment -> m Deployment

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Deployment -> m Deployment

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Deployment -> m Deployment

Read Deployment

Methods

readsPrec :: Int -> ReadS Deployment

readList :: ReadS [Deployment]

readPrec :: ReadPrec Deployment

readListPrec :: ReadPrec [Deployment]

Show Deployment

Methods

showsPrec :: Int -> Deployment -> ShowS

show :: Deployment -> String

showList :: [Deployment] -> ShowS

Generic Deployment

Associated Types

type Rep Deployment :: * -> *

Methods

from :: Deployment -> Rep Deployment x

to :: Rep Deployment x -> Deployment

Hashable Deployment

Methods

hashWithSalt :: Int -> Deployment -> Int

hash :: Deployment -> Int

FromJSON Deployment

Methods

parseJSON :: Value -> Parser Deployment

parseJSONList :: Value -> Parser [Deployment]

NFData Deployment

Methods

rnf :: Deployment -> ()

type Rep Deployment

type Rep Deployment = D1 * (MetaData "Deployment" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.6.0-JJ9NJtNe0aRBcVRYpJCEA2" False) (C1 * (MetaCons "Deployment'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dApiSummary") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text (Map Text MethodSnapshot))))) (S1 * (MetaSel (Just Symbol "_dCreatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))))

Response Lenses

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

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.