software.amazon.awscdk.services.ssm

Interface CfnMaintenanceWindowTaskProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMaintenanceWindowTaskProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:19.343Z")
 @Stability(value=Stable)
public interface CfnMaintenanceWindowTaskProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `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;
 CfnMaintenanceWindowTaskProps cfnMaintenanceWindowTaskProps = CfnMaintenanceWindowTaskProps.builder()
         .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	Interface and Description
static class	CfnMaintenanceWindowTaskProps.Builder A builder for CfnMaintenanceWindowTaskProps
static class	CfnMaintenanceWindowTaskProps.Jsii$Proxy An implementation for CfnMaintenanceWindowTaskProps

Method Summary

Modifier and Type	Method and Description
static CfnMaintenanceWindowTaskProps.Builder	builder()
default String	getCutoffBehavior() `AWS::SSM::MaintenanceWindowTask.CutoffBehavior`.
default String	getDescription() `AWS::SSM::MaintenanceWindowTask.Description`.
default Object	getLoggingInfo() `AWS::SSM::MaintenanceWindowTask.LoggingInfo`.
default String	getMaxConcurrency() `AWS::SSM::MaintenanceWindowTask.MaxConcurrency`.
default String	getMaxErrors() `AWS::SSM::MaintenanceWindowTask.MaxErrors`.
default String	getName() `AWS::SSM::MaintenanceWindowTask.Name`.
Number	getPriority() `AWS::SSM::MaintenanceWindowTask.Priority`.
default String	getServiceRoleArn() `AWS::SSM::MaintenanceWindowTask.ServiceRoleArn`.
default Object	getTargets() `AWS::SSM::MaintenanceWindowTask.Targets`.
String	getTaskArn() `AWS::SSM::MaintenanceWindowTask.TaskArn`.
default Object	getTaskInvocationParameters() `AWS::SSM::MaintenanceWindowTask.TaskInvocationParameters`.
default Object	getTaskParameters() `AWS::SSM::MaintenanceWindowTask.TaskParameters`.
String	getTaskType() `AWS::SSM::MaintenanceWindowTask.TaskType`.
String	getWindowId() `AWS::SSM::MaintenanceWindowTask.WindowId`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCutoffBehavior

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

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

getDescription

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

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

getLoggingInfo

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

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

getMaxConcurrency

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

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

getMaxErrors

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

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

getName

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

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

getPriority

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

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

getServiceRoleArn

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

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

getTargets

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

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

getTaskArn

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

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

getTaskInvocationParameters

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

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

getTaskParameters

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

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

getTaskType

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

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

getWindowId

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

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

builder

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

Returns:

a CfnMaintenanceWindowTaskProps.Builder of CfnMaintenanceWindowTaskProps