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.OpsWorks.CreateDeployment

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Runs deployment or stack commands. For more information, see Deploying Apps and Run Stack Commands.

Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Synopsis

data CreateDeployment = CreateDeployment' {
- appId :: Maybe Text
- comment :: Maybe Text
- customJson :: Maybe Text
- instanceIds :: Maybe [Text]
- layerIds :: Maybe [Text]
- stackId :: Text
- command :: DeploymentCommand
}
newCreateDeployment :: Text -> DeploymentCommand -> CreateDeployment
createDeployment_appId :: Lens' CreateDeployment (Maybe Text)
createDeployment_comment :: Lens' CreateDeployment (Maybe Text)
createDeployment_customJson :: Lens' CreateDeployment (Maybe Text)
createDeployment_instanceIds :: Lens' CreateDeployment (Maybe [Text])
createDeployment_layerIds :: Lens' CreateDeployment (Maybe [Text])
createDeployment_stackId :: Lens' CreateDeployment Text
createDeployment_command :: Lens' CreateDeployment DeploymentCommand
data CreateDeploymentResponse = CreateDeploymentResponse' {
- deploymentId :: Maybe Text
- httpStatus :: Int
}
newCreateDeploymentResponse :: Int -> CreateDeploymentResponse
createDeploymentResponse_deploymentId :: Lens' CreateDeploymentResponse (Maybe Text)
createDeploymentResponse_httpStatus :: Lens' CreateDeploymentResponse Int

Creating a Request

data CreateDeployment Source #

See: newCreateDeployment smart constructor.

Constructors

CreateDeployment'

Fields

appId :: Maybe Text
The app ID. This parameter is required for app deployments, but not for other deployment commands.
comment :: Maybe Text
A user-defined comment.
customJson :: Maybe Text
A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding default stack configuration JSON values. The string should be in the following format:
```
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
```
For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes and Overriding Attributes With Custom JSON.
instanceIds :: Maybe [Text]
The instance IDs for the deployment targets.
layerIds :: Maybe [Text]
The layer IDs for the deployment targets.
stackId :: Text
The stack ID.
command :: DeploymentCommand
A DeploymentCommand object that specifies the deployment command and any associated arguments.

Instances

Instances details

ToJSON CreateDeployment Source #
Instance details Defined in Amazonka.OpsWorks.CreateDeployment Methods toJSON :: CreateDeployment -> Value # toEncoding :: CreateDeployment -> Encoding # toJSONList :: [CreateDeployment] -> Value # toEncodingList :: [CreateDeployment] -> Encoding #
ToHeaders CreateDeployment Source #
Instance details Defined in Amazonka.OpsWorks.CreateDeployment Methods toHeaders :: CreateDeployment -> [Header] #
ToPath CreateDeployment Source #
Instance details Defined in Amazonka.OpsWorks.CreateDeployment Methods toPath :: CreateDeployment -> ByteString #
ToQuery CreateDeployment Source #
Instance details Defined in Amazonka.OpsWorks.CreateDeployment Methods toQuery :: CreateDeployment -> QueryString #
AWSRequest CreateDeployment Source #
Instance details Defined in Amazonka.OpsWorks.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.OpsWorks.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.OpsWorks.CreateDeployment Methods readsPrec :: Int -> ReadS CreateDeployment # readList :: ReadS [CreateDeployment] # readPrec :: ReadPrec CreateDeployment # readListPrec :: ReadPrec [CreateDeployment] #
Show CreateDeployment Source #
Instance details Defined in Amazonka.OpsWorks.CreateDeployment Methods showsPrec :: Int -> CreateDeployment -> ShowS # show :: CreateDeployment -> String # showList :: [CreateDeployment] -> ShowS #
NFData CreateDeployment Source #
Instance details Defined in Amazonka.OpsWorks.CreateDeployment Methods rnf :: CreateDeployment -> () #
Eq CreateDeployment Source #
Instance details Defined in Amazonka.OpsWorks.CreateDeployment Methods (==) :: CreateDeployment -> CreateDeployment -> Bool # (/=) :: CreateDeployment -> CreateDeployment -> Bool #
Hashable CreateDeployment Source #
Instance details Defined in Amazonka.OpsWorks.CreateDeployment Methods hashWithSalt :: Int -> CreateDeployment -> Int # hash :: CreateDeployment -> Int #
type AWSResponse CreateDeployment Source #
Instance details Defined in Amazonka.OpsWorks.CreateDeployment type AWSResponse CreateDeployment = CreateDeploymentResponse
type Rep CreateDeployment Source #
Instance details Defined in Amazonka.OpsWorks.CreateDeployment type Rep CreateDeployment = D1 ('MetaData "CreateDeployment" "Amazonka.OpsWorks.CreateDeployment" "amazonka-opsworks-2.0-7XrzSD2vbuN9lVUGWMVZ7S" 'False) (C1 ('MetaCons "CreateDeployment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "comment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "customJson") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "instanceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "layerIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "stackId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "command") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeploymentCommand)))))

newCreateDeployment Source #

Arguments

:: Text	`CreateDeployment`
-> DeploymentCommand	`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_appId - The app ID. This parameter is required for app deployments, but not for other deployment commands.

CreateDeployment, createDeployment_comment - A user-defined comment.

CreateDeployment, createDeployment_customJson - A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding default stack configuration JSON values. The string should be in the following format:

"{\"key1\": \"value1\", \"key2\": \"value2\",...}"

For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes and Overriding Attributes With Custom JSON.

CreateDeployment, createDeployment_instanceIds - The instance IDs for the deployment targets.

CreateDeployment, createDeployment_layerIds - The layer IDs for the deployment targets.

CreateDeployment, createDeployment_stackId - The stack ID.

CreateDeployment, createDeployment_command - A DeploymentCommand object that specifies the deployment command and any associated arguments.

Request Lenses

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

The app ID. This parameter is required for app deployments, but not for other deployment commands.

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

A user-defined comment.

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

A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding default stack configuration JSON values. The string should be in the following format:

"{\"key1\": \"value1\", \"key2\": \"value2\",...}"

For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes and Overriding Attributes With Custom JSON.

createDeployment_instanceIds :: Lens' CreateDeployment (Maybe [Text]) Source #

The instance IDs for the deployment targets.

createDeployment_layerIds :: Lens' CreateDeployment (Maybe [Text]) Source #

The layer IDs for the deployment targets.

createDeployment_stackId :: Lens' CreateDeployment Text Source #

The stack ID.

createDeployment_command :: Lens' CreateDeployment DeploymentCommand Source #

A DeploymentCommand object that specifies the deployment command and any associated arguments.

Destructuring the Response

data CreateDeploymentResponse Source #

Contains the response to a CreateDeployment request.

See: newCreateDeploymentResponse smart constructor.

Constructors

CreateDeploymentResponse'
Fields deploymentId :: Maybe Text The deployment ID, which can be used with other requests to identify the deployment. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateDeploymentResponse Source #
Instance details Defined in Amazonka.OpsWorks.CreateDeployment Associated Types type Rep CreateDeploymentResponse :: Type -> Type # Methods from :: CreateDeploymentResponse -> Rep CreateDeploymentResponse x # to :: Rep CreateDeploymentResponse x -> CreateDeploymentResponse #
Read CreateDeploymentResponse Source #
Instance details Defined in Amazonka.OpsWorks.CreateDeployment Methods readsPrec :: Int -> ReadS CreateDeploymentResponse # readList :: ReadS [CreateDeploymentResponse] # readPrec :: ReadPrec CreateDeploymentResponse # readListPrec :: ReadPrec [CreateDeploymentResponse] #
Show CreateDeploymentResponse Source #
Instance details Defined in Amazonka.OpsWorks.CreateDeployment Methods showsPrec :: Int -> CreateDeploymentResponse -> ShowS # show :: CreateDeploymentResponse -> String # showList :: [CreateDeploymentResponse] -> ShowS #
NFData CreateDeploymentResponse Source #
Instance details Defined in Amazonka.OpsWorks.CreateDeployment Methods rnf :: CreateDeploymentResponse -> () #
Eq CreateDeploymentResponse Source #
Instance details Defined in Amazonka.OpsWorks.CreateDeployment Methods (==) :: CreateDeploymentResponse -> CreateDeploymentResponse -> Bool # (/=) :: CreateDeploymentResponse -> CreateDeploymentResponse -> Bool #
type Rep CreateDeploymentResponse Source #
Instance details Defined in Amazonka.OpsWorks.CreateDeployment type Rep CreateDeploymentResponse = D1 ('MetaData "CreateDeploymentResponse" "Amazonka.OpsWorks.CreateDeployment" "amazonka-opsworks-2.0-7XrzSD2vbuN9lVUGWMVZ7S" 'False) (C1 ('MetaCons "CreateDeploymentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDeploymentResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateDeploymentResponse'`
-> CreateDeploymentResponse

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

CreateDeploymentResponse, createDeploymentResponse_deploymentId - The deployment ID, which can be used with other requests to identify the deployment.

$sel:httpStatus:CreateDeploymentResponse', createDeploymentResponse_httpStatus - The response's http status code.

Response Lenses

createDeploymentResponse_deploymentId :: Lens' CreateDeploymentResponse (Maybe Text) Source #

The deployment ID, which can be used with other requests to identify the deployment.

createDeploymentResponse_httpStatus :: Lens' CreateDeploymentResponse Int Source #

The response's http status code.