| 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.GreengrassV2.CreateDeployment
Description
Creates a continuous deployment for a target, which is a Greengrass core device or group of core devices. When you add a new core device to a group of core devices that has a deployment, IoT Greengrass deploys that group's deployment to the new device.
You can define one deployment for each target. When you create a new deployment for a target that has an existing deployment, you replace the previous deployment. IoT Greengrass applies the new deployment to the target devices.
Every deployment has a revision number that indicates how many deployment revisions you define for a target. Use this operation to create a new revision of an existing deployment.
For more information, see the Create deployments in the IoT Greengrass V2 Developer Guide.
Synopsis
- data CreateDeployment = CreateDeployment' {
- clientToken :: Maybe Text
- components :: Maybe (HashMap Text ComponentDeploymentSpecification)
- deploymentName :: Maybe Text
- deploymentPolicies :: Maybe DeploymentPolicies
- iotJobConfiguration :: Maybe DeploymentIoTJobConfiguration
- parentTargetArn :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- targetArn :: Text
- newCreateDeployment :: Text -> CreateDeployment
- createDeployment_clientToken :: Lens' CreateDeployment (Maybe Text)
- createDeployment_components :: Lens' CreateDeployment (Maybe (HashMap Text ComponentDeploymentSpecification))
- createDeployment_deploymentName :: Lens' CreateDeployment (Maybe Text)
- createDeployment_deploymentPolicies :: Lens' CreateDeployment (Maybe DeploymentPolicies)
- createDeployment_iotJobConfiguration :: Lens' CreateDeployment (Maybe DeploymentIoTJobConfiguration)
- createDeployment_parentTargetArn :: Lens' CreateDeployment (Maybe Text)
- createDeployment_tags :: Lens' CreateDeployment (Maybe (HashMap Text Text))
- createDeployment_targetArn :: Lens' CreateDeployment Text
- data CreateDeploymentResponse = CreateDeploymentResponse' {}
- newCreateDeploymentResponse :: Int -> CreateDeploymentResponse
- createDeploymentResponse_deploymentId :: Lens' CreateDeploymentResponse (Maybe Text)
- createDeploymentResponse_iotJobArn :: Lens' CreateDeploymentResponse (Maybe Text)
- createDeploymentResponse_iotJobId :: Lens' CreateDeploymentResponse (Maybe Text)
- createDeploymentResponse_httpStatus :: Lens' CreateDeploymentResponse Int
Creating a Request
data CreateDeployment Source #
See: newCreateDeployment smart constructor.
Constructors
| CreateDeployment' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> 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:
$sel:clientToken:CreateDeployment', createDeployment_clientToken - A unique, case-sensitive identifier that you can provide to ensure that
the request is idempotent. Idempotency means that the request is
successfully processed only once, even if you send the request multiple
times. When a request succeeds, and you specify the same client token
for subsequent successful requests, the IoT Greengrass V2 service
returns the successful response that it caches from the previous
request. IoT Greengrass V2 caches successful responses for idempotent
requests for up to 8 hours.
$sel:components:CreateDeployment', createDeployment_components - The components to deploy. This is a dictionary, where each key is the
name of a component, and each key's value is the version and
configuration to deploy for that component.
CreateDeployment, createDeployment_deploymentName - The name of the deployment.
$sel:deploymentPolicies:CreateDeployment', createDeployment_deploymentPolicies - The deployment policies for the deployment. These policies define how
the deployment updates components and handles failure.
$sel:iotJobConfiguration:CreateDeployment', createDeployment_iotJobConfiguration - The job configuration for the deployment configuration. The job
configuration specifies the rollout, timeout, and stop configurations
for the deployment configuration.
CreateDeployment, createDeployment_parentTargetArn - The parent deployment's target
ARN
within a subdeployment.
$sel:tags:CreateDeployment', createDeployment_tags - A list of key-value pairs that contain metadata for the resource. For
more information, see
Tag your resources
in the IoT Greengrass V2 Developer Guide.
CreateDeployment, createDeployment_targetArn - The
ARN
of the target IoT thing or thing group. When creating a subdeployment,
the targetARN can only be a thing group.
Request Lenses
createDeployment_clientToken :: Lens' CreateDeployment (Maybe Text) Source #
A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent. Idempotency means that the request is successfully processed only once, even if you send the request multiple times. When a request succeeds, and you specify the same client token for subsequent successful requests, the IoT Greengrass V2 service returns the successful response that it caches from the previous request. IoT Greengrass V2 caches successful responses for idempotent requests for up to 8 hours.
createDeployment_components :: Lens' CreateDeployment (Maybe (HashMap Text ComponentDeploymentSpecification)) Source #
The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.
createDeployment_deploymentName :: Lens' CreateDeployment (Maybe Text) Source #
The name of the deployment.
createDeployment_deploymentPolicies :: Lens' CreateDeployment (Maybe DeploymentPolicies) Source #
The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.
createDeployment_iotJobConfiguration :: Lens' CreateDeployment (Maybe DeploymentIoTJobConfiguration) Source #
The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.
createDeployment_parentTargetArn :: Lens' CreateDeployment (Maybe Text) Source #
The parent deployment's target ARN within a subdeployment.
createDeployment_tags :: Lens' CreateDeployment (Maybe (HashMap Text Text)) Source #
A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
createDeployment_targetArn :: Lens' CreateDeployment Text Source #
The ARN of the target IoT thing or thing group. When creating a subdeployment, the targetARN can only be a thing group.
Destructuring the Response
data CreateDeploymentResponse Source #
See: newCreateDeploymentResponse smart constructor.
Constructors
| CreateDeploymentResponse' | |
Instances
newCreateDeploymentResponse Source #
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 ID of the deployment.
CreateDeploymentResponse, createDeploymentResponse_iotJobArn - The
ARN
of the IoT job that applies the deployment to target devices.
CreateDeploymentResponse, createDeploymentResponse_iotJobId - The ID of the IoT job that applies the deployment to target devices.
$sel:httpStatus:CreateDeploymentResponse', createDeploymentResponse_httpStatus - The response's http status code.
Response Lenses
createDeploymentResponse_deploymentId :: Lens' CreateDeploymentResponse (Maybe Text) Source #
The ID of the deployment.
createDeploymentResponse_iotJobArn :: Lens' CreateDeploymentResponse (Maybe Text) Source #
The ARN of the IoT job that applies the deployment to target devices.
createDeploymentResponse_iotJobId :: Lens' CreateDeploymentResponse (Maybe Text) Source #
The ID of the IoT job that applies the deployment to target devices.
createDeploymentResponse_httpStatus :: Lens' CreateDeploymentResponse Int Source #
The response's http status code.