Show / Hide Table of Contents

Class CfnDeployment

Creates a continuous deployment for a target, which is a AWS IoT Greengrass core device or group of core devices.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnDeployment
Implements
IInspectable
IDeploymentRef
IConstruct
IDependable
IEnvironmentAware
ITaggable
Inherited Members
CfnResource.IsCfnResource(object)
CfnResource.AddDeletionOverride(string)
CfnResource.AddDependency(CfnResource)
CfnResource.AddDependsOn(CfnResource)
CfnResource.AddMetadata(string, object)
CfnResource.AddOverride(string, object)
CfnResource.AddPropertyDeletionOverride(string)
CfnResource.AddPropertyOverride(string, object)
CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)
CfnResource.GetAtt(string, ResolutionTypeHint?)
CfnResource.GetMetadata(string)
CfnResource.ObtainDependencies()
CfnResource.ObtainResourceDependencies()
CfnResource.RemoveDependency(CfnResource)
CfnResource.ReplaceDependency(CfnResource, CfnResource)
CfnResource.ShouldSynthesize()
CfnResource.ToString()
CfnResource.ValidateProperties(object)
CfnResource.CfnOptions
CfnResource.CfnResourceType
CfnResource.Env
CfnResource.UpdatedProperites
CfnResource.UpdatedProperties
CfnRefElement.Ref
CfnElement.IsCfnElement(object)
CfnElement.OverrideLogicalId(string)
CfnElement.With(params IMixin[])
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Namespace: Amazon.CDK.AWS.GreengrassV2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDeployment : CfnResource, IInspectable, IDeploymentRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnDeployment Inherits CfnResource Implements IInspectable, IDeploymentRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Remarks

When you add a new core device to a group of core devices that has a deployment, AWS 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. AWS IoT Greengrass applies the new deployment to the target devices.

You can only add, update, or delete up to 10 deployments at a time to a single target.

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. This operation returns the revision number of the new deployment when you create it.

For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide .

Deployment resources are deleted when you delete stacks. To keep the deployments in a stack, you must specify <code>"DeletionPolicy": "Retain"</code> on each deployment resource in the stack template that you want to keep. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html">DeletionPolicy</a> .

You can only delete up to 10 deployment resources at a time. If you delete more than 10 resources, you receive an error.

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

CloudformationResource: AWS::GreengrassV2::Deployment

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.GreengrassV2;

             var rateIncreaseCriteria;

             var cfnDeployment = new CfnDeployment(this, "MyCfnDeployment", new CfnDeploymentProps {
                 TargetArn = "targetArn",

                 // the properties below are optional
                 Components = new Dictionary<string, object> {
                     { "componentsKey", new ComponentDeploymentSpecificationProperty {
                         ComponentVersion = "componentVersion",
                         ConfigurationUpdate = new ComponentConfigurationUpdateProperty {
                             Merge = "merge",
                             Reset = new [] { "reset" }
                         },
                         RunWith = new ComponentRunWithProperty {
                             PosixUser = "posixUser",
                             SystemResourceLimits = new SystemResourceLimitsProperty {
                                 Cpus = 123,
                                 Memory = 123
                             },
                             WindowsUser = "windowsUser"
                         }
                     } }
                 },
                 DeploymentName = "deploymentName",
                 DeploymentPolicies = new DeploymentPoliciesProperty {
                     ComponentUpdatePolicy = new DeploymentComponentUpdatePolicyProperty {
                         Action = "action",
                         TimeoutInSeconds = 123
                     },
                     ConfigurationValidationPolicy = new DeploymentConfigurationValidationPolicyProperty {
                         TimeoutInSeconds = 123
                     },
                     FailureHandlingPolicy = "failureHandlingPolicy"
                 },
                 IotJobConfiguration = new DeploymentIoTJobConfigurationProperty {
                     AbortConfig = new IoTJobAbortConfigProperty {
                         CriteriaList = new [] { new IoTJobAbortCriteriaProperty {
                             Action = "action",
                             FailureType = "failureType",
                             MinNumberOfExecutedThings = 123,
                             ThresholdPercentage = 123
                         } }
                     },
                     JobExecutionsRolloutConfig = new IoTJobExecutionsRolloutConfigProperty {
                         ExponentialRate = new IoTJobExponentialRolloutRateProperty {
                             BaseRatePerMinute = 123,
                             IncrementFactor = 123,
                             RateIncreaseCriteria = rateIncreaseCriteria
                         },
                         MaximumPerMinute = 123
                     },
                     TimeoutConfig = new IoTJobTimeoutConfigProperty {
                         InProgressTimeoutInMinutes = 123
                     }
                 },
                 ParentTargetArn = "parentTargetArn",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 }
             });

Synopsis

Constructors

CfnDeployment(Construct, string, ICfnDeploymentProps)

Create a new AWS::GreengrassV2::Deployment.

Properties

AttrDeploymentId

The ID of the deployment.

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

CfnProperties

Creates a continuous deployment for a target, which is a AWS IoT Greengrass core device or group of core devices.

Components

The components to deploy.

DeploymentName

The name of the deployment.

DeploymentPolicies

The deployment policies for the deployment.

DeploymentRef

A reference to a Deployment resource.

IotJobConfiguration

The job configuration for the deployment configuration.

ParentTargetArn

The parent deployment's ARN for a subdeployment.

Tags

Tag Manager which manages the tags for this resource.

TagsRaw

Application-specific metadata to attach to the deployment.

TargetArn

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

Methods

ArnForDeployment(IDeploymentRef)

Creates a continuous deployment for a target, which is a AWS IoT Greengrass core device or group of core devices.

FromDeploymentId(Construct, string, string)

Creates a new IDeploymentRef from a deploymentId.

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

IsCfnDeployment(object)

Checks whether the given object is a CfnDeployment.

RenderProperties(IDictionary<string, object>)

Creates a continuous deployment for a target, which is a AWS IoT Greengrass core device or group of core devices.

Constructors

CfnDeployment(Construct, string, ICfnDeploymentProps)

Create a new AWS::GreengrassV2::Deployment.

public CfnDeployment(Construct scope, string id, ICfnDeploymentProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnDeploymentProps

Resource properties.

Remarks

When you add a new core device to a group of core devices that has a deployment, AWS 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. AWS IoT Greengrass applies the new deployment to the target devices.

You can only add, update, or delete up to 10 deployments at a time to a single target.

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. This operation returns the revision number of the new deployment when you create it.

For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide .

Deployment resources are deleted when you delete stacks. To keep the deployments in a stack, you must specify <code>"DeletionPolicy": "Retain"</code> on each deployment resource in the stack template that you want to keep. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html">DeletionPolicy</a> .

You can only delete up to 10 deployment resources at a time. If you delete more than 10 resources, you receive an error.

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

CloudformationResource: AWS::GreengrassV2::Deployment

ExampleMetadata: fixture=_generated

Properties

AttrDeploymentId

The ID of the deployment.

public virtual string AttrDeploymentId { get; }
Property Value

string

Remarks

CloudformationAttribute: DeploymentId

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

When you add a new core device to a group of core devices that has a deployment, AWS 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. AWS IoT Greengrass applies the new deployment to the target devices.

You can only add, update, or delete up to 10 deployments at a time to a single target.

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. This operation returns the revision number of the new deployment when you create it.

For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide .

Deployment resources are deleted when you delete stacks. To keep the deployments in a stack, you must specify <code>"DeletionPolicy": "Retain"</code> on each deployment resource in the stack template that you want to keep. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html">DeletionPolicy</a> .

You can only delete up to 10 deployment resources at a time. If you delete more than 10 resources, you receive an error.

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

CloudformationResource: AWS::GreengrassV2::Deployment

ExampleMetadata: fixture=_generated

CfnProperties

Creates a continuous deployment for a target, which is a AWS IoT Greengrass core device or group of core devices.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
CfnResource.CfnProperties
Remarks

When you add a new core device to a group of core devices that has a deployment, AWS 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. AWS IoT Greengrass applies the new deployment to the target devices.

You can only add, update, or delete up to 10 deployments at a time to a single target.

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. This operation returns the revision number of the new deployment when you create it.

For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide .

Deployment resources are deleted when you delete stacks. To keep the deployments in a stack, you must specify <code>"DeletionPolicy": "Retain"</code> on each deployment resource in the stack template that you want to keep. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html">DeletionPolicy</a> .

You can only delete up to 10 deployment resources at a time. If you delete more than 10 resources, you receive an error.

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

CloudformationResource: AWS::GreengrassV2::Deployment

ExampleMetadata: fixture=_generated

Components

The components to deploy.

public virtual object? Components { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or Dictionary<string, either IResolvable or CfnDeployment.IComponentDeploymentSpecificationProperty>

DeploymentName

The name of the deployment.

public virtual string? DeploymentName { get; set; }
Property Value

string

Remarks

When you add a new core device to a group of core devices that has a deployment, AWS 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. AWS IoT Greengrass applies the new deployment to the target devices.

You can only add, update, or delete up to 10 deployments at a time to a single target.

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. This operation returns the revision number of the new deployment when you create it.

For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide .

Deployment resources are deleted when you delete stacks. To keep the deployments in a stack, you must specify <code>"DeletionPolicy": "Retain"</code> on each deployment resource in the stack template that you want to keep. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html">DeletionPolicy</a> .

You can only delete up to 10 deployment resources at a time. If you delete more than 10 resources, you receive an error.

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

CloudformationResource: AWS::GreengrassV2::Deployment

ExampleMetadata: fixture=_generated

DeploymentPolicies

The deployment policies for the deployment.

public virtual object? DeploymentPolicies { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnDeployment.IDeploymentPoliciesProperty

DeploymentRef

A reference to a Deployment resource.

public virtual IDeploymentReference DeploymentRef { get; }
Property Value

IDeploymentReference

Remarks

When you add a new core device to a group of core devices that has a deployment, AWS 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. AWS IoT Greengrass applies the new deployment to the target devices.

You can only add, update, or delete up to 10 deployments at a time to a single target.

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. This operation returns the revision number of the new deployment when you create it.

For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide .

Deployment resources are deleted when you delete stacks. To keep the deployments in a stack, you must specify <code>"DeletionPolicy": "Retain"</code> on each deployment resource in the stack template that you want to keep. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html">DeletionPolicy</a> .

You can only delete up to 10 deployment resources at a time. If you delete more than 10 resources, you receive an error.

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

CloudformationResource: AWS::GreengrassV2::Deployment

ExampleMetadata: fixture=_generated

IotJobConfiguration

The job configuration for the deployment configuration.

public virtual object? IotJobConfiguration { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnDeployment.IDeploymentIoTJobConfigurationProperty

ParentTargetArn

The parent deployment's ARN for a subdeployment.

public virtual string? ParentTargetArn { get; set; }
Property Value

string

Remarks

When you add a new core device to a group of core devices that has a deployment, AWS 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. AWS IoT Greengrass applies the new deployment to the target devices.

You can only add, update, or delete up to 10 deployments at a time to a single target.

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. This operation returns the revision number of the new deployment when you create it.

For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide .

Deployment resources are deleted when you delete stacks. To keep the deployments in a stack, you must specify <code>"DeletionPolicy": "Retain"</code> on each deployment resource in the stack template that you want to keep. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html">DeletionPolicy</a> .

You can only delete up to 10 deployment resources at a time. If you delete more than 10 resources, you receive an error.

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

CloudformationResource: AWS::GreengrassV2::Deployment

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

When you add a new core device to a group of core devices that has a deployment, AWS 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. AWS IoT Greengrass applies the new deployment to the target devices.

You can only add, update, or delete up to 10 deployments at a time to a single target.

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. This operation returns the revision number of the new deployment when you create it.

For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide .

Deployment resources are deleted when you delete stacks. To keep the deployments in a stack, you must specify <code>"DeletionPolicy": "Retain"</code> on each deployment resource in the stack template that you want to keep. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html">DeletionPolicy</a> .

You can only delete up to 10 deployment resources at a time. If you delete more than 10 resources, you receive an error.

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

CloudformationResource: AWS::GreengrassV2::Deployment

ExampleMetadata: fixture=_generated

TagsRaw

Application-specific metadata to attach to the deployment.

public virtual IDictionary<string, string>? TagsRaw { get; set; }
Property Value

IDictionary<string, string>

Remarks

When you add a new core device to a group of core devices that has a deployment, AWS 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. AWS IoT Greengrass applies the new deployment to the target devices.

You can only add, update, or delete up to 10 deployments at a time to a single target.

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. This operation returns the revision number of the new deployment when you create it.

For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide .

Deployment resources are deleted when you delete stacks. To keep the deployments in a stack, you must specify <code>"DeletionPolicy": "Retain"</code> on each deployment resource in the stack template that you want to keep. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html">DeletionPolicy</a> .

You can only delete up to 10 deployment resources at a time. If you delete more than 10 resources, you receive an error.

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

CloudformationResource: AWS::GreengrassV2::Deployment

ExampleMetadata: fixture=_generated

TargetArn

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

public virtual string TargetArn { get; set; }
Property Value

string

Remarks

When you add a new core device to a group of core devices that has a deployment, AWS 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. AWS IoT Greengrass applies the new deployment to the target devices.

You can only add, update, or delete up to 10 deployments at a time to a single target.

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. This operation returns the revision number of the new deployment when you create it.

For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide .

Deployment resources are deleted when you delete stacks. To keep the deployments in a stack, you must specify <code>"DeletionPolicy": "Retain"</code> on each deployment resource in the stack template that you want to keep. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html">DeletionPolicy</a> .

You can only delete up to 10 deployment resources at a time. If you delete more than 10 resources, you receive an error.

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

CloudformationResource: AWS::GreengrassV2::Deployment

ExampleMetadata: fixture=_generated

Methods

ArnForDeployment(IDeploymentRef)

Creates a continuous deployment for a target, which is a AWS IoT Greengrass core device or group of core devices.

public static string ArnForDeployment(IDeploymentRef resource)
Parameters
resource IDeploymentRef
Returns

string

Remarks

When you add a new core device to a group of core devices that has a deployment, AWS 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. AWS IoT Greengrass applies the new deployment to the target devices.

You can only add, update, or delete up to 10 deployments at a time to a single target.

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. This operation returns the revision number of the new deployment when you create it.

For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide .

Deployment resources are deleted when you delete stacks. To keep the deployments in a stack, you must specify <code>"DeletionPolicy": "Retain"</code> on each deployment resource in the stack template that you want to keep. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html">DeletionPolicy</a> .

You can only delete up to 10 deployment resources at a time. If you delete more than 10 resources, you receive an error.

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

CloudformationResource: AWS::GreengrassV2::Deployment

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.GreengrassV2;

             var rateIncreaseCriteria;

             var cfnDeployment = new CfnDeployment(this, "MyCfnDeployment", new CfnDeploymentProps {
                 TargetArn = "targetArn",

                 // the properties below are optional
                 Components = new Dictionary<string, object> {
                     { "componentsKey", new ComponentDeploymentSpecificationProperty {
                         ComponentVersion = "componentVersion",
                         ConfigurationUpdate = new ComponentConfigurationUpdateProperty {
                             Merge = "merge",
                             Reset = new [] { "reset" }
                         },
                         RunWith = new ComponentRunWithProperty {
                             PosixUser = "posixUser",
                             SystemResourceLimits = new SystemResourceLimitsProperty {
                                 Cpus = 123,
                                 Memory = 123
                             },
                             WindowsUser = "windowsUser"
                         }
                     } }
                 },
                 DeploymentName = "deploymentName",
                 DeploymentPolicies = new DeploymentPoliciesProperty {
                     ComponentUpdatePolicy = new DeploymentComponentUpdatePolicyProperty {
                         Action = "action",
                         TimeoutInSeconds = 123
                     },
                     ConfigurationValidationPolicy = new DeploymentConfigurationValidationPolicyProperty {
                         TimeoutInSeconds = 123
                     },
                     FailureHandlingPolicy = "failureHandlingPolicy"
                 },
                 IotJobConfiguration = new DeploymentIoTJobConfigurationProperty {
                     AbortConfig = new IoTJobAbortConfigProperty {
                         CriteriaList = new [] { new IoTJobAbortCriteriaProperty {
                             Action = "action",
                             FailureType = "failureType",
                             MinNumberOfExecutedThings = 123,
                             ThresholdPercentage = 123
                         } }
                     },
                     JobExecutionsRolloutConfig = new IoTJobExecutionsRolloutConfigProperty {
                         ExponentialRate = new IoTJobExponentialRolloutRateProperty {
                             BaseRatePerMinute = 123,
                             IncrementFactor = 123,
                             RateIncreaseCriteria = rateIncreaseCriteria
                         },
                         MaximumPerMinute = 123
                     },
                     TimeoutConfig = new IoTJobTimeoutConfigProperty {
                         InProgressTimeoutInMinutes = 123
                     }
                 },
                 ParentTargetArn = "parentTargetArn",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 }
             });

FromDeploymentId(Construct, string, string)

Creates a new IDeploymentRef from a deploymentId.

public static IDeploymentRef FromDeploymentId(Construct scope, string id, string deploymentId)
Parameters
scope Construct
id string
deploymentId string
Returns

IDeploymentRef

Remarks

When you add a new core device to a group of core devices that has a deployment, AWS 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. AWS IoT Greengrass applies the new deployment to the target devices.

You can only add, update, or delete up to 10 deployments at a time to a single target.

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. This operation returns the revision number of the new deployment when you create it.

For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide .

Deployment resources are deleted when you delete stacks. To keep the deployments in a stack, you must specify <code>"DeletionPolicy": "Retain"</code> on each deployment resource in the stack template that you want to keep. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html">DeletionPolicy</a> .

You can only delete up to 10 deployment resources at a time. If you delete more than 10 resources, you receive an error.

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

CloudformationResource: AWS::GreengrassV2::Deployment

ExampleMetadata: fixture=_generated

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

When you add a new core device to a group of core devices that has a deployment, AWS 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. AWS IoT Greengrass applies the new deployment to the target devices.

You can only add, update, or delete up to 10 deployments at a time to a single target.

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. This operation returns the revision number of the new deployment when you create it.

For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide .

Deployment resources are deleted when you delete stacks. To keep the deployments in a stack, you must specify <code>"DeletionPolicy": "Retain"</code> on each deployment resource in the stack template that you want to keep. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html">DeletionPolicy</a> .

You can only delete up to 10 deployment resources at a time. If you delete more than 10 resources, you receive an error.

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

CloudformationResource: AWS::GreengrassV2::Deployment

ExampleMetadata: fixture=_generated

IsCfnDeployment(object)

Checks whether the given object is a CfnDeployment.

public static bool IsCfnDeployment(object x)
Parameters
x object
Returns

bool

Remarks

When you add a new core device to a group of core devices that has a deployment, AWS 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. AWS IoT Greengrass applies the new deployment to the target devices.

You can only add, update, or delete up to 10 deployments at a time to a single target.

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. This operation returns the revision number of the new deployment when you create it.

For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide .

Deployment resources are deleted when you delete stacks. To keep the deployments in a stack, you must specify <code>"DeletionPolicy": "Retain"</code> on each deployment resource in the stack template that you want to keep. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html">DeletionPolicy</a> .

You can only delete up to 10 deployment resources at a time. If you delete more than 10 resources, you receive an error.

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

CloudformationResource: AWS::GreengrassV2::Deployment

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a continuous deployment for a target, which is a AWS IoT Greengrass core device or group of core devices.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
CfnResource.RenderProperties(IDictionary<string, object>)
Remarks

When you add a new core device to a group of core devices that has a deployment, AWS 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. AWS IoT Greengrass applies the new deployment to the target devices.

You can only add, update, or delete up to 10 deployments at a time to a single target.

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. This operation returns the revision number of the new deployment when you create it.

For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide .

Deployment resources are deleted when you delete stacks. To keep the deployments in a stack, you must specify <code>"DeletionPolicy": "Retain"</code> on each deployment resource in the stack template that you want to keep. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html">DeletionPolicy</a> .

You can only delete up to 10 deployment resources at a time. If you delete more than 10 resources, you receive an error.

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

CloudformationResource: AWS::GreengrassV2::Deployment

ExampleMetadata: fixture=_generated

Implements

IInspectable
IDeploymentRef
Constructs.IConstruct
Constructs.IDependable
IEnvironmentAware
ITaggable
Back to top Generated by DocFX