software.amazon.awscdk.services.greengrassv2

Interface CfnDeploymentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeploymentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:49.889Z")
 @Stability(value=Stable)
public interface CfnDeploymentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnDeployment`.

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;
 CfnDeploymentProps cfnDeploymentProps = CfnDeploymentProps.builder()
         .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	Interface and Description
static class	CfnDeploymentProps.Builder A builder for CfnDeploymentProps
static class	CfnDeploymentProps.Jsii$Proxy An implementation for CfnDeploymentProps

Method Summary

Modifier and Type	Method and Description
static CfnDeploymentProps.Builder	builder()
default Object	getComponents() `AWS::GreengrassV2::Deployment.Components`.
default String	getDeploymentName() `AWS::GreengrassV2::Deployment.DeploymentName`.
default Object	getDeploymentPolicies() `AWS::GreengrassV2::Deployment.DeploymentPolicies`.
default Object	getIotJobConfiguration() `AWS::GreengrassV2::Deployment.IotJobConfiguration`.
default Map<String,String>	getTags() `AWS::GreengrassV2::Deployment.Tags`.
String	getTargetArn() `AWS::GreengrassV2::Deployment.TargetArn`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getTargetArn

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

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

getComponents

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

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

getDeploymentName

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

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

getDeploymentPolicies

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

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

getIotJobConfiguration

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

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

getTags

@Stability(value=Stable)
 @Nullable
default Map<String,String> getTags()

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

builder

@Stability(value=Stable)
static CfnDeploymentProps.Builder builder()

Returns:

a CfnDeploymentProps.Builder of CfnDeploymentProps