software.amazon.awscdk.services.ssm

Class CfnMaintenanceWindowTask

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ssm.CfnMaintenanceWindowTask

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:19.341Z")
 @Stability(value=Stable)
public class CfnMaintenanceWindowTask
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SSM::MaintenanceWindowTask`.

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.ssm.*;
 Object parameters;
 Object taskParameters;
 CfnMaintenanceWindowTask cfnMaintenanceWindowTask = CfnMaintenanceWindowTask.Builder.create(this, "MyCfnMaintenanceWindowTask")
         .priority(123)
         .taskArn("taskArn")
         .taskType("taskType")
         .windowId("windowId")
         // the properties below are optional
         .cutoffBehavior("cutoffBehavior")
         .description("description")
         .loggingInfo(LoggingInfoProperty.builder()
                 .region("region")
                 .s3Bucket("s3Bucket")
                 // the properties below are optional
                 .s3Prefix("s3Prefix")
                 .build())
         .maxConcurrency("maxConcurrency")
         .maxErrors("maxErrors")
         .name("name")
         .serviceRoleArn("serviceRoleArn")
         .targets(List.of(TargetProperty.builder()
                 .key("key")
                 .values(List.of("values"))
                 .build()))
         .taskInvocationParameters(TaskInvocationParametersProperty.builder()
                 .maintenanceWindowAutomationParameters(MaintenanceWindowAutomationParametersProperty.builder()
                         .documentVersion("documentVersion")
                         .parameters(parameters)
                         .build())
                 .maintenanceWindowLambdaParameters(MaintenanceWindowLambdaParametersProperty.builder()
                         .clientContext("clientContext")
                         .payload("payload")
                         .qualifier("qualifier")
                         .build())
                 .maintenanceWindowRunCommandParameters(MaintenanceWindowRunCommandParametersProperty.builder()
                         .comment("comment")
                         .documentHash("documentHash")
                         .documentHashType("documentHashType")
                         .notificationConfig(NotificationConfigProperty.builder()
                                 .notificationArn("notificationArn")
                                 // the properties below are optional
                                 .notificationEvents(List.of("notificationEvents"))
                                 .notificationType("notificationType")
                                 .build())
                         .outputS3BucketName("outputS3BucketName")
                         .outputS3KeyPrefix("outputS3KeyPrefix")
                         .parameters(parameters)
                         .serviceRoleArn("serviceRoleArn")
                         .timeoutSeconds(123)
                         .build())
                 .maintenanceWindowStepFunctionsParameters(MaintenanceWindowStepFunctionsParametersProperty.builder()
                         .input("input")
                         .name("name")
                         .build())
                 .build())
         .taskParameters(taskParameters)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnMaintenanceWindowTask.Builder A fluent builder for CfnMaintenanceWindowTask.
static interface	CfnMaintenanceWindowTask.LoggingInfoProperty Example:
static interface	CfnMaintenanceWindowTask.MaintenanceWindowAutomationParametersProperty Example:
static interface	CfnMaintenanceWindowTask.MaintenanceWindowLambdaParametersProperty Example:
static interface	CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty Example:
static interface	CfnMaintenanceWindowTask.MaintenanceWindowStepFunctionsParametersProperty Example:
static interface	CfnMaintenanceWindowTask.NotificationConfigProperty Example:
static interface	CfnMaintenanceWindowTask.TargetProperty Example:
static interface	CfnMaintenanceWindowTask.TaskInvocationParametersProperty 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.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.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
	CfnMaintenanceWindowTask(software.constructs.Construct scope, String id, CfnMaintenanceWindowTaskProps props) Create a new `AWS::SSM::MaintenanceWindowTask`.
protected	CfnMaintenanceWindowTask(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnMaintenanceWindowTask(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getCutoffBehavior() `AWS::SSM::MaintenanceWindowTask.CutoffBehavior`.
String	getDescription() `AWS::SSM::MaintenanceWindowTask.Description`.
Object	getLoggingInfo() `AWS::SSM::MaintenanceWindowTask.LoggingInfo`.
String	getMaxConcurrency() `AWS::SSM::MaintenanceWindowTask.MaxConcurrency`.
String	getMaxErrors() `AWS::SSM::MaintenanceWindowTask.MaxErrors`.
String	getName() `AWS::SSM::MaintenanceWindowTask.Name`.
Number	getPriority() `AWS::SSM::MaintenanceWindowTask.Priority`.
String	getServiceRoleArn() `AWS::SSM::MaintenanceWindowTask.ServiceRoleArn`.
Object	getTargets() `AWS::SSM::MaintenanceWindowTask.Targets`.
String	getTaskArn() `AWS::SSM::MaintenanceWindowTask.TaskArn`.
Object	getTaskInvocationParameters() `AWS::SSM::MaintenanceWindowTask.TaskInvocationParameters`.
Object	getTaskParameters() `AWS::SSM::MaintenanceWindowTask.TaskParameters`.
String	getTaskType() `AWS::SSM::MaintenanceWindowTask.TaskType`.
String	getWindowId() `AWS::SSM::MaintenanceWindowTask.WindowId`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCutoffBehavior(String value) `AWS::SSM::MaintenanceWindowTask.CutoffBehavior`.
void	setDescription(String value) `AWS::SSM::MaintenanceWindowTask.Description`.
void	setLoggingInfo(CfnMaintenanceWindowTask.LoggingInfoProperty value) `AWS::SSM::MaintenanceWindowTask.LoggingInfo`.
void	setLoggingInfo(IResolvable value) `AWS::SSM::MaintenanceWindowTask.LoggingInfo`.
void	setMaxConcurrency(String value) `AWS::SSM::MaintenanceWindowTask.MaxConcurrency`.
void	setMaxErrors(String value) `AWS::SSM::MaintenanceWindowTask.MaxErrors`.
void	setName(String value) `AWS::SSM::MaintenanceWindowTask.Name`.
void	setPriority(Number value) `AWS::SSM::MaintenanceWindowTask.Priority`.
void	setServiceRoleArn(String value) `AWS::SSM::MaintenanceWindowTask.ServiceRoleArn`.
void	setTargets(IResolvable value) `AWS::SSM::MaintenanceWindowTask.Targets`.
void	setTargets(List<Object> value) `AWS::SSM::MaintenanceWindowTask.Targets`.
void	setTaskArn(String value) `AWS::SSM::MaintenanceWindowTask.TaskArn`.
void	setTaskInvocationParameters(CfnMaintenanceWindowTask.TaskInvocationParametersProperty value) `AWS::SSM::MaintenanceWindowTask.TaskInvocationParameters`.
void	setTaskInvocationParameters(IResolvable value) `AWS::SSM::MaintenanceWindowTask.TaskInvocationParameters`.
void	setTaskParameters(Object value) `AWS::SSM::MaintenanceWindowTask.TaskParameters`.
void	setTaskType(String value) `AWS::SSM::MaintenanceWindowTask.TaskType`.
void	setWindowId(String value) `AWS::SSM::MaintenanceWindowTask.WindowId`.

Methods inherited from class software.amazon.awscdk.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.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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

CfnMaintenanceWindowTask

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

CfnMaintenanceWindowTask

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

CfnMaintenanceWindowTask

@Stability(value=Stable)
public CfnMaintenanceWindowTask(@NotNull
                                                         software.constructs.Construct scope,
                                                         @NotNull
                                                         String id,
                                                         @NotNull
                                                         CfnMaintenanceWindowTaskProps props)

Create a new `AWS::SSM::MaintenanceWindowTask`.

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.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getCutoffBehavior

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

`AWS::SSM::MaintenanceWindowTask.CutoffBehavior`.

setCutoffBehavior

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

`AWS::SSM::MaintenanceWindowTask.CutoffBehavior`.

getDescription

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

`AWS::SSM::MaintenanceWindowTask.Description`.

setDescription

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

`AWS::SSM::MaintenanceWindowTask.Description`.

getLoggingInfo

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

`AWS::SSM::MaintenanceWindowTask.LoggingInfo`.

setLoggingInfo

@Stability(value=Stable)
public void setLoggingInfo(@Nullable
                                                    CfnMaintenanceWindowTask.LoggingInfoProperty value)

`AWS::SSM::MaintenanceWindowTask.LoggingInfo`.

setLoggingInfo

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

`AWS::SSM::MaintenanceWindowTask.LoggingInfo`.

getMaxConcurrency

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

`AWS::SSM::MaintenanceWindowTask.MaxConcurrency`.

setMaxConcurrency

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

`AWS::SSM::MaintenanceWindowTask.MaxConcurrency`.

getMaxErrors

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

`AWS::SSM::MaintenanceWindowTask.MaxErrors`.

setMaxErrors

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

`AWS::SSM::MaintenanceWindowTask.MaxErrors`.

getName

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

`AWS::SSM::MaintenanceWindowTask.Name`.

setName

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

`AWS::SSM::MaintenanceWindowTask.Name`.

getPriority

@Stability(value=Stable)
 @NotNull
public Number getPriority()

`AWS::SSM::MaintenanceWindowTask.Priority`.

setPriority

@Stability(value=Stable)
public void setPriority(@NotNull
                                                 Number value)

`AWS::SSM::MaintenanceWindowTask.Priority`.

getServiceRoleArn

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

`AWS::SSM::MaintenanceWindowTask.ServiceRoleArn`.

setServiceRoleArn

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

`AWS::SSM::MaintenanceWindowTask.ServiceRoleArn`.

getTargets

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

`AWS::SSM::MaintenanceWindowTask.Targets`.

setTargets

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

`AWS::SSM::MaintenanceWindowTask.Targets`.

setTargets

@Stability(value=Stable)
public void setTargets(@Nullable
                                                List<Object> value)

`AWS::SSM::MaintenanceWindowTask.Targets`.

getTaskArn

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

`AWS::SSM::MaintenanceWindowTask.TaskArn`.

setTaskArn

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

`AWS::SSM::MaintenanceWindowTask.TaskArn`.

getTaskInvocationParameters

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

`AWS::SSM::MaintenanceWindowTask.TaskInvocationParameters`.

setTaskInvocationParameters

@Stability(value=Stable)
public void setTaskInvocationParameters(@Nullable
                                                                 CfnMaintenanceWindowTask.TaskInvocationParametersProperty value)

`AWS::SSM::MaintenanceWindowTask.TaskInvocationParameters`.

setTaskInvocationParameters

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

`AWS::SSM::MaintenanceWindowTask.TaskInvocationParameters`.

getTaskParameters

@Stability(value=Stable)
 @NotNull
public Object getTaskParameters()

`AWS::SSM::MaintenanceWindowTask.TaskParameters`.

setTaskParameters

@Stability(value=Stable)
public void setTaskParameters(@NotNull
                                                       Object value)

`AWS::SSM::MaintenanceWindowTask.TaskParameters`.

getTaskType

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

`AWS::SSM::MaintenanceWindowTask.TaskType`.

setTaskType

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

`AWS::SSM::MaintenanceWindowTask.TaskType`.

getWindowId

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

`AWS::SSM::MaintenanceWindowTask.WindowId`.

setWindowId

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

`AWS::SSM::MaintenanceWindowTask.WindowId`.