Package software.amazon.awscdk.services.ssm

Class CfnMaintenanceWindowTaskProps.Builder

java.lang.Object

software.amazon.awscdk.services.ssm.CfnMaintenanceWindowTaskProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnMaintenanceWindowTaskProps>

Enclosing interface:

CfnMaintenanceWindowTaskProps

@Stability(Stable)
public static final class CfnMaintenanceWindowTaskProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnMaintenanceWindowTaskProps>

A builder for CfnMaintenanceWindowTaskProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnMaintenanceWindowTaskProps	build()	Builds the configured instance.
CfnMaintenanceWindowTaskProps.Builder	cutoffBehavior(String cutoffBehavior)	Sets the value of CfnMaintenanceWindowTaskProps.getCutoffBehavior()
CfnMaintenanceWindowTaskProps.Builder	description(String description)	Sets the value of CfnMaintenanceWindowTaskProps.getDescription()
CfnMaintenanceWindowTaskProps.Builder	loggingInfo(IResolvable loggingInfo)	Sets the value of CfnMaintenanceWindowTaskProps.getLoggingInfo()
CfnMaintenanceWindowTaskProps.Builder	loggingInfo(CfnMaintenanceWindowTask.LoggingInfoProperty loggingInfo)	Sets the value of CfnMaintenanceWindowTaskProps.getLoggingInfo()
CfnMaintenanceWindowTaskProps.Builder	maxConcurrency(String maxConcurrency)	Sets the value of CfnMaintenanceWindowTaskProps.getMaxConcurrency()
CfnMaintenanceWindowTaskProps.Builder	maxErrors(String maxErrors)	Sets the value of CfnMaintenanceWindowTaskProps.getMaxErrors()
CfnMaintenanceWindowTaskProps.Builder	name(String name)	Sets the value of CfnMaintenanceWindowTaskProps.getName()
CfnMaintenanceWindowTaskProps.Builder	priority(Number priority)	Sets the value of CfnMaintenanceWindowTaskProps.getPriority()
CfnMaintenanceWindowTaskProps.Builder	serviceRoleArn(String serviceRoleArn)	Sets the value of CfnMaintenanceWindowTaskProps.getServiceRoleArn()
CfnMaintenanceWindowTaskProps.Builder	targets(List<? extends Object> targets)	Sets the value of CfnMaintenanceWindowTaskProps.getTargets()
CfnMaintenanceWindowTaskProps.Builder	targets(IResolvable targets)	Sets the value of CfnMaintenanceWindowTaskProps.getTargets()
CfnMaintenanceWindowTaskProps.Builder	taskArn(String taskArn)	Sets the value of CfnMaintenanceWindowTaskProps.getTaskArn()
CfnMaintenanceWindowTaskProps.Builder	taskInvocationParameters(IResolvable taskInvocationParameters)	Sets the value of CfnMaintenanceWindowTaskProps.getTaskInvocationParameters()
CfnMaintenanceWindowTaskProps.Builder	taskInvocationParameters(CfnMaintenanceWindowTask.TaskInvocationParametersProperty taskInvocationParameters)	Sets the value of CfnMaintenanceWindowTaskProps.getTaskInvocationParameters()
CfnMaintenanceWindowTaskProps.Builder	taskParameters(Object taskParameters)	Sets the value of CfnMaintenanceWindowTaskProps.getTaskParameters()
CfnMaintenanceWindowTaskProps.Builder	taskType(String taskType)	Sets the value of CfnMaintenanceWindowTaskProps.getTaskType()
CfnMaintenanceWindowTaskProps.Builder	windowId(String windowId)	Sets the value of CfnMaintenanceWindowTaskProps.getWindowId()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

priority

@Stability(Stable)
public CfnMaintenanceWindowTaskProps.Builder priority(Number priority)

Sets the value of CfnMaintenanceWindowTaskProps.getPriority()

Parameters:

priority - The priority of the task in the maintenance window. This parameter is required. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

Returns:

this

taskArn

@Stability(Stable)
public CfnMaintenanceWindowTaskProps.Builder taskArn(String taskArn)

Sets the value of CfnMaintenanceWindowTaskProps.getTaskArn()

Parameters:

taskArn - The resource that the task uses during execution. This parameter is required. For RUN_COMMAND and AUTOMATION task types, TaskArn is the SSM document name or Amazon Resource Name (ARN).

For LAMBDA tasks, TaskArn is the function name or ARN.

For STEP_FUNCTIONS tasks, TaskArn is the state machine ARN.

Returns:

this

taskType

@Stability(Stable)
public CfnMaintenanceWindowTaskProps.Builder taskType(String taskType)

Sets the value of CfnMaintenanceWindowTaskProps.getTaskType()

Parameters:

taskType - The type of task. This parameter is required. Valid values: RUN_COMMAND , AUTOMATION , LAMBDA , STEP_FUNCTIONS .

Returns:

this

windowId

@Stability(Stable)
public CfnMaintenanceWindowTaskProps.Builder windowId(String windowId)

Sets the value of CfnMaintenanceWindowTaskProps.getWindowId()

Parameters:

windowId - The ID of the maintenance window where the task is registered. This parameter is required.

Returns:

this

cutoffBehavior

@Stability(Stable)
public CfnMaintenanceWindowTaskProps.Builder cutoffBehavior(String cutoffBehavior)

Sets the value of CfnMaintenanceWindowTaskProps.getCutoffBehavior()

Parameters:

cutoffBehavior - The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

Returns:

this

description

@Stability(Stable)
public CfnMaintenanceWindowTaskProps.Builder description(String description)

Sets the value of CfnMaintenanceWindowTaskProps.getDescription()

Parameters:

description - A description of the task.

Returns:

this

loggingInfo

@Stability(Stable)
public CfnMaintenanceWindowTaskProps.Builder loggingInfo(IResolvable loggingInfo)

Sets the value of CfnMaintenanceWindowTaskProps.getLoggingInfo()

Parameters:

loggingInfo - Information about an Amazon S3 bucket to write Run Command task-level logs to.

LoggingInfo has been deprecated. To specify an Amazon S3 bucket to contain logs for Run Command tasks, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see AWS ::SSM::MaintenanceWindowTask MaintenanceWindowRunCommandParameters .

Returns:

this

loggingInfo

@Stability(Stable)
public CfnMaintenanceWindowTaskProps.Builder loggingInfo(CfnMaintenanceWindowTask.LoggingInfoProperty loggingInfo)

Sets the value of CfnMaintenanceWindowTaskProps.getLoggingInfo()

Parameters:

loggingInfo - Information about an Amazon S3 bucket to write Run Command task-level logs to.

LoggingInfo has been deprecated. To specify an Amazon S3 bucket to contain logs for Run Command tasks, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see AWS ::SSM::MaintenanceWindowTask MaintenanceWindowRunCommandParameters .

Returns:

this

maxConcurrency

@Stability(Stable)
public CfnMaintenanceWindowTaskProps.Builder maxConcurrency(String maxConcurrency)

Sets the value of CfnMaintenanceWindowTaskProps.getMaxConcurrency()

Parameters:

maxConcurrency - The maximum number of targets this task can be run for, in parallel.

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1 . This value doesn't affect the running of your task.

Returns:

this

maxErrors

@Stability(Stable)
public CfnMaintenanceWindowTaskProps.Builder maxErrors(String maxErrors)

Sets the value of CfnMaintenanceWindowTaskProps.getMaxErrors()

Parameters:

maxErrors - The maximum number of errors allowed before this task stops being scheduled.

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1 . This value doesn't affect the running of your task.

Returns:

this

name

@Stability(Stable)
public CfnMaintenanceWindowTaskProps.Builder name(String name)

Sets the value of CfnMaintenanceWindowTaskProps.getName()

Parameters:

name - The task name.

Returns:

this

serviceRoleArn

@Stability(Stable)
public CfnMaintenanceWindowTaskProps.Builder serviceRoleArn(String serviceRoleArn)

Sets the value of CfnMaintenanceWindowTaskProps.getServiceRoleArn()

Parameters:

serviceRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

Returns:

this

targets

@Stability(Stable)
public CfnMaintenanceWindowTaskProps.Builder targets(IResolvable targets)

Sets the value of CfnMaintenanceWindowTaskProps.getTargets()

Parameters:

targets - The targets, either instances or window target IDs.

• Specify instances using Key=InstanceIds,Values= *instanceid1* , *instanceid2* .
• Specify window target IDs using Key=WindowTargetIds,Values= *window-target-id-1* , *window-target-id-2* .

Returns:

this

targets

@Stability(Stable)
public CfnMaintenanceWindowTaskProps.Builder targets(List<? extends Object> targets)

Sets the value of CfnMaintenanceWindowTaskProps.getTargets()

Parameters:

targets - The targets, either instances or window target IDs.

• Specify instances using Key=InstanceIds,Values= *instanceid1* , *instanceid2* .
• Specify window target IDs using Key=WindowTargetIds,Values= *window-target-id-1* , *window-target-id-2* .

Returns:

this

taskInvocationParameters

@Stability(Stable)
public CfnMaintenanceWindowTaskProps.Builder taskInvocationParameters(IResolvable taskInvocationParameters)

Sets the value of CfnMaintenanceWindowTaskProps.getTaskInvocationParameters()

Parameters:

taskInvocationParameters - The parameters to pass to the task when it runs. Populate only the fields that match the task type. All other fields should be empty.

When you update a maintenance window task that has options specified in TaskInvocationParameters , you must provide again all the TaskInvocationParameters values that you want to retain. The values you do not specify again are removed. For example, suppose that when you registered a Run Command task, you specified TaskInvocationParameters values for Comment , NotificationConfig , and OutputS3BucketName . If you update the maintenance window task and specify only a different OutputS3BucketName value, the values for Comment and NotificationConfig are removed.

Returns:

this

taskInvocationParameters

@Stability(Stable)
public CfnMaintenanceWindowTaskProps.Builder taskInvocationParameters(CfnMaintenanceWindowTask.TaskInvocationParametersProperty taskInvocationParameters)

Sets the value of CfnMaintenanceWindowTaskProps.getTaskInvocationParameters()

Parameters:

taskInvocationParameters - The parameters to pass to the task when it runs. Populate only the fields that match the task type. All other fields should be empty.

When you update a maintenance window task that has options specified in TaskInvocationParameters , you must provide again all the TaskInvocationParameters values that you want to retain. The values you do not specify again are removed. For example, suppose that when you registered a Run Command task, you specified TaskInvocationParameters values for Comment , NotificationConfig , and OutputS3BucketName . If you update the maintenance window task and specify only a different OutputS3BucketName value, the values for Comment and NotificationConfig are removed.

Returns:

this

taskParameters

@Stability(Stable)
public CfnMaintenanceWindowTaskProps.Builder taskParameters(Object taskParameters)

Sets the value of CfnMaintenanceWindowTaskProps.getTaskParameters()

Parameters:

taskParameters - The parameters to pass to the task when it runs.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters .

Returns:

this

build

@Stability(Stable)
public CfnMaintenanceWindowTaskProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnMaintenanceWindowTaskProps>

Returns:

a new instance of CfnMaintenanceWindowTaskProps

Throws:

NullPointerException - if any required attribute was not provided