software.amazon.awscdk.services.greengrassv2

Class CfnDeployment

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.greengrassv2.CfnDeployment

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:49.873Z")
 @Stability(value=Stable)
public class CfnDeployment
extends CfnResource
implements IInspectable

A CloudFormation `AWS::GreengrassV2::Deployment`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.greengrassv2.*;
 Object rateIncreaseCriteria;
 CfnDeployment cfnDeployment = CfnDeployment.Builder.create(this, "MyCfnDeployment")
         .targetArn("targetArn")
         // the properties below are optional
         .components(Map.of(
                 "componentsKey", ComponentDeploymentSpecificationProperty.builder()
                         .componentVersion("componentVersion")
                         .configurationUpdate(ComponentConfigurationUpdateProperty.builder()
                                 .merge("merge")
                                 .reset(List.of("reset"))
                                 .build())
                         .runWith(ComponentRunWithProperty.builder()
                                 .posixUser("posixUser")
                                 .systemResourceLimits(SystemResourceLimitsProperty.builder()
                                         .cpus(123)
                                         .memory(123)
                                         .build())
                                 .windowsUser("windowsUser")
                                 .build())
                         .build()))
         .deploymentName("deploymentName")
         .deploymentPolicies(DeploymentPoliciesProperty.builder()
                 .componentUpdatePolicy(DeploymentComponentUpdatePolicyProperty.builder()
                         .action("action")
                         .timeoutInSeconds(123)
                         .build())
                 .configurationValidationPolicy(DeploymentConfigurationValidationPolicyProperty.builder()
                         .timeoutInSeconds(123)
                         .build())
                 .failureHandlingPolicy("failureHandlingPolicy")
                 .build())
         .iotJobConfiguration(DeploymentIoTJobConfigurationProperty.builder()
                 .abortConfig(IoTJobAbortConfigProperty.builder()
                         .criteriaList(List.of(IoTJobAbortCriteriaProperty.builder()
                                 .action("action")
                                 .failureType("failureType")
                                 .minNumberOfExecutedThings(123)
                                 .thresholdPercentage(123)
                                 .build()))
                         .build())
                 .jobExecutionsRolloutConfig(IoTJobExecutionsRolloutConfigProperty.builder()
                         .exponentialRate(IoTJobExponentialRolloutRateProperty.builder()
                                 .baseRatePerMinute(123)
                                 .incrementFactor(123)
                                 .rateIncreaseCriteria(rateIncreaseCriteria)
                                 .build())
                         .maximumPerMinute(123)
                         .build())
                 .timeoutConfig(IoTJobTimeoutConfigProperty.builder()
                         .inProgressTimeoutInMinutes(123)
                         .build())
                 .build())
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDeployment.Builder A fluent builder for CfnDeployment.
static interface	CfnDeployment.ComponentConfigurationUpdateProperty Example:
static interface	CfnDeployment.ComponentDeploymentSpecificationProperty Example:
static interface	CfnDeployment.ComponentRunWithProperty Example:
static interface	CfnDeployment.DeploymentComponentUpdatePolicyProperty Example:
static interface	CfnDeployment.DeploymentConfigurationValidationPolicyProperty Example:
static interface	CfnDeployment.DeploymentIoTJobConfigurationProperty Example:
static interface	CfnDeployment.DeploymentPoliciesProperty Example:
static interface	CfnDeployment.IoTJobAbortConfigProperty Example:
static interface	CfnDeployment.IoTJobAbortCriteriaProperty Example:
static interface	CfnDeployment.IoTJobExecutionsRolloutConfigProperty Example:
static interface	CfnDeployment.IoTJobExponentialRolloutRateProperty Example:
static interface	CfnDeployment.IoTJobTimeoutConfigProperty Example:
static interface	CfnDeployment.SystemResourceLimitsProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDeployment(Construct scope, String id, CfnDeploymentProps props) Create a new `AWS::GreengrassV2::Deployment`.
protected	CfnDeployment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDeployment(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrDeploymentId()
protected Map<String,Object>	getCfnProperties()
Object	getComponents() `AWS::GreengrassV2::Deployment.Components`.
String	getDeploymentName() `AWS::GreengrassV2::Deployment.DeploymentName`.
Object	getDeploymentPolicies() `AWS::GreengrassV2::Deployment.DeploymentPolicies`.
Object	getIotJobConfiguration() `AWS::GreengrassV2::Deployment.IotJobConfiguration`.
TagManager	getTags() `AWS::GreengrassV2::Deployment.Tags`.
String	getTargetArn() `AWS::GreengrassV2::Deployment.TargetArn`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setComponents(IResolvable value) `AWS::GreengrassV2::Deployment.Components`.
void	setComponents(Map<String,Object> value) `AWS::GreengrassV2::Deployment.Components`.
void	setDeploymentName(String value) `AWS::GreengrassV2::Deployment.DeploymentName`.
void	setDeploymentPolicies(CfnDeployment.DeploymentPoliciesProperty value) `AWS::GreengrassV2::Deployment.DeploymentPolicies`.
void	setDeploymentPolicies(IResolvable value) `AWS::GreengrassV2::Deployment.DeploymentPolicies`.
void	setIotJobConfiguration(CfnDeployment.DeploymentIoTJobConfigurationProperty value) `AWS::GreengrassV2::Deployment.IotJobConfiguration`.
void	setIotJobConfiguration(IResolvable value) `AWS::GreengrassV2::Deployment.IotJobConfiguration`.
void	setTargetArn(String value) `AWS::GreengrassV2::Deployment.TargetArn`.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDeployment

protected CfnDeployment(software.amazon.jsii.JsiiObjectRef objRef)

CfnDeployment

protected CfnDeployment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDeployment

@Stability(value=Stable)
public CfnDeployment(@NotNull
                                              Construct scope,
                                              @NotNull
                                              String id,
                                              @NotNull
                                              CfnDeploymentProps props)

Create a new `AWS::GreengrassV2::Deployment`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrDeploymentId

@Stability(value=Stable)
 @NotNull
public String getAttrDeploymentId()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::GreengrassV2::Deployment.Tags`.

getTargetArn

@Stability(value=Stable)
 @NotNull
public String getTargetArn()

`AWS::GreengrassV2::Deployment.TargetArn`.

setTargetArn

@Stability(value=Stable)
public void setTargetArn(@NotNull
                                                  String value)

`AWS::GreengrassV2::Deployment.TargetArn`.

getComponents

@Stability(value=Stable)
 @Nullable
public Object getComponents()

`AWS::GreengrassV2::Deployment.Components`.

setComponents

@Stability(value=Stable)
public void setComponents(@Nullable
                                                   IResolvable value)

`AWS::GreengrassV2::Deployment.Components`.

setComponents

@Stability(value=Stable)
public void setComponents(@Nullable
                                                   Map<String,Object> value)

`AWS::GreengrassV2::Deployment.Components`.

getDeploymentName

@Stability(value=Stable)
 @Nullable
public String getDeploymentName()

`AWS::GreengrassV2::Deployment.DeploymentName`.

setDeploymentName

@Stability(value=Stable)
public void setDeploymentName(@Nullable
                                                       String value)

`AWS::GreengrassV2::Deployment.DeploymentName`.

getDeploymentPolicies

@Stability(value=Stable)
 @Nullable
public Object getDeploymentPolicies()

`AWS::GreengrassV2::Deployment.DeploymentPolicies`.

setDeploymentPolicies

@Stability(value=Stable)
public void setDeploymentPolicies(@Nullable
                                                           CfnDeployment.DeploymentPoliciesProperty value)

`AWS::GreengrassV2::Deployment.DeploymentPolicies`.

setDeploymentPolicies

@Stability(value=Stable)
public void setDeploymentPolicies(@Nullable
                                                           IResolvable value)

`AWS::GreengrassV2::Deployment.DeploymentPolicies`.

getIotJobConfiguration

@Stability(value=Stable)
 @Nullable
public Object getIotJobConfiguration()

`AWS::GreengrassV2::Deployment.IotJobConfiguration`.

setIotJobConfiguration

@Stability(value=Stable)
public void setIotJobConfiguration(@Nullable
                                                            CfnDeployment.DeploymentIoTJobConfigurationProperty value)

`AWS::GreengrassV2::Deployment.IotJobConfiguration`.

setIotJobConfiguration

@Stability(value=Stable)
public void setIotJobConfiguration(@Nullable
                                                            IResolvable value)

`AWS::GreengrassV2::Deployment.IotJobConfiguration`.