CfnDeploymentProps

class aws_cdk.aws_greengrassv2.CfnDeploymentProps(*, target_arn, components=None, deployment_name=None, deployment_policies=None, iot_job_configuration=None, parent_target_arn=None, tags=None)

Bases: object

Properties for defining a CfnDeployment.

Parameters:

  • target_arn (str) – The ARN of the target AWS IoT thing or thing group.

  • components (Union[IResolvable, Mapping[str, Union[IResolvable, ComponentDeploymentSpecificationProperty, Dict[str, Any]]], None]) – 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.

  • deployment_name (Optional[str]) – The name of the deployment.

  • deployment_policies (Union[IResolvable, DeploymentPoliciesProperty, Dict[str, Any], None]) – The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.

  • iot_job_configuration (Union[IResolvable, DeploymentIoTJobConfigurationProperty, Dict[str, Any], None]) – The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.

  • parent_target_arn (Optional[str]) – The parent deployment’s ARN for a subdeployment.

  • tags (Optional[Mapping[str, str]]) – Application-specific metadata to attach to the deployment. You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see Tag your AWS IoT Greengrass Version 2 resources in the AWS IoT Greengrass V2 Developer Guide . This Json property type is processed as a map of key-value pairs. It uses the following format, which is different from most Tags implementations in AWS CloudFormation templates:: “Tags”: { “KeyName0”: “value”, “KeyName1”: “value”, “KeyName2”: “value” }

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_greengrassv2 as greengrassv2

# rate_increase_criteria: Any

cfn_deployment_props = greengrassv2.CfnDeploymentProps(
    target_arn="targetArn",

    # the properties below are optional
    components={
        "components_key": greengrassv2.CfnDeployment.ComponentDeploymentSpecificationProperty(
            component_version="componentVersion",
            configuration_update=greengrassv2.CfnDeployment.ComponentConfigurationUpdateProperty(
                merge="merge",
                reset=["reset"]
            ),
            run_with=greengrassv2.CfnDeployment.ComponentRunWithProperty(
                posix_user="posixUser",
                system_resource_limits=greengrassv2.CfnDeployment.SystemResourceLimitsProperty(
                    cpus=123,
                    memory=123
                ),
                windows_user="windowsUser"
            )
        )
    },
    deployment_name="deploymentName",
    deployment_policies=greengrassv2.CfnDeployment.DeploymentPoliciesProperty(
        component_update_policy=greengrassv2.CfnDeployment.DeploymentComponentUpdatePolicyProperty(
            action="action",
            timeout_in_seconds=123
        ),
        configuration_validation_policy=greengrassv2.CfnDeployment.DeploymentConfigurationValidationPolicyProperty(
            timeout_in_seconds=123
        ),
        failure_handling_policy="failureHandlingPolicy"
    ),
    iot_job_configuration=greengrassv2.CfnDeployment.DeploymentIoTJobConfigurationProperty(
        abort_config=greengrassv2.CfnDeployment.IoTJobAbortConfigProperty(
            criteria_list=[greengrassv2.CfnDeployment.IoTJobAbortCriteriaProperty(
                action="action",
                failure_type="failureType",
                min_number_of_executed_things=123,
                threshold_percentage=123
            )]
        ),
        job_executions_rollout_config=greengrassv2.CfnDeployment.IoTJobExecutionsRolloutConfigProperty(
            exponential_rate=greengrassv2.CfnDeployment.IoTJobExponentialRolloutRateProperty(
                base_rate_per_minute=123,
                increment_factor=123,
                rate_increase_criteria=rate_increase_criteria
            ),
            maximum_per_minute=123
        ),
        timeout_config=greengrassv2.CfnDeployment.IoTJobTimeoutConfigProperty(
            in_progress_timeout_in_minutes=123
        )
    ),
    parent_target_arn="parentTargetArn",
    tags={
        "tags_key": "tags"
    }
)

Attributes

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.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-components

deployment_name

The name of the deployment.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-deploymentname

deployment_policies

The deployment policies for the deployment.

These policies define how the deployment updates components and handles failure.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-deploymentpolicies

iot_job_configuration

The job configuration for the deployment configuration.

The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-iotjobconfiguration

parent_target_arn

The parent deployment’s ARN for a subdeployment.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-parenttargetarn

tags

Application-specific metadata to attach to the deployment.

You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see Tag your AWS IoT Greengrass Version 2 resources in the AWS IoT Greengrass V2 Developer Guide .

This Json property type is processed as a map of key-value pairs. It uses the following format, which is different from most Tags implementations in AWS CloudFormation templates:

"Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
}
Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-tags

target_arn

The ARN of the target AWS IoT thing or thing group.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrassv2-deployment.html#cfn-greengrassv2-deployment-targetarn