Package software.amazon.awscdk.cfnpropertymixins.services.ssm

Class CfnMaintenanceWindowTaskMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.ssm.CfnMaintenanceWindowTaskMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnMaintenanceWindowTaskMixinProps>

Enclosing interface:

CfnMaintenanceWindowTaskMixinProps

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

A builder for CfnMaintenanceWindowTaskMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

cutoffBehavior

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

Sets the value of CfnMaintenanceWindowTaskMixinProps.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 CfnMaintenanceWindowTaskMixinProps.Builder description(String description)

Sets the value of CfnMaintenanceWindowTaskMixinProps.getDescription()

Parameters:

description - A description of the task.

Returns:

this

loggingInfo

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

Sets the value of CfnMaintenanceWindowTaskMixinProps.getLoggingInfo()

Parameters:

loggingInfo -

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 .

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

Returns:

this

loggingInfo

@Stability(Stable)
public CfnMaintenanceWindowTaskMixinProps.Builder loggingInfo(CfnMaintenanceWindowTaskPropsMixin.LoggingInfoProperty loggingInfo)

Sets the value of CfnMaintenanceWindowTaskMixinProps.getLoggingInfo()

Parameters:

loggingInfo -

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 .

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

Returns:

this

maxConcurrency

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

Sets the value of CfnMaintenanceWindowTaskMixinProps.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 CfnMaintenanceWindowTaskMixinProps.Builder maxErrors(String maxErrors)

Sets the value of CfnMaintenanceWindowTaskMixinProps.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 CfnMaintenanceWindowTaskMixinProps.Builder name(String name)

Sets the value of CfnMaintenanceWindowTaskMixinProps.getName()

Parameters:

name - The task name.

Returns:

this

priority

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

Sets the value of CfnMaintenanceWindowTaskMixinProps.getPriority()

Parameters:

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

Returns:

this

serviceRoleArn

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

Sets the value of CfnMaintenanceWindowTaskMixinProps.getServiceRoleArn()

Parameters:

serviceRoleArn - The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow .

However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the AWS Systems Manager User Guide .

Returns:

this

targets

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

Sets the value of CfnMaintenanceWindowTaskMixinProps.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 CfnMaintenanceWindowTaskMixinProps.Builder targets(List<? extends Object> targets)

Sets the value of CfnMaintenanceWindowTaskMixinProps.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

taskArn

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

Sets the value of CfnMaintenanceWindowTaskMixinProps.getTaskArn()

Parameters:

taskArn - The resource that the task uses during execution. 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

taskInvocationParameters

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

Sets the value of CfnMaintenanceWindowTaskMixinProps.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 CfnMaintenanceWindowTaskMixinProps.Builder taskInvocationParameters(CfnMaintenanceWindowTaskPropsMixin.TaskInvocationParametersProperty taskInvocationParameters)

Sets the value of CfnMaintenanceWindowTaskMixinProps.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 CfnMaintenanceWindowTaskMixinProps.Builder taskParameters(Object taskParameters)

Sets the value of CfnMaintenanceWindowTaskMixinProps.getTaskParameters()

Parameters:

taskParameters -

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 .

The parameters to pass to the task when it runs.

Returns:

this

taskType

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

Sets the value of CfnMaintenanceWindowTaskMixinProps.getTaskType()

Parameters:

taskType - The type of task. Valid values: RUN_COMMAND , AUTOMATION , LAMBDA , STEP_FUNCTIONS .

Returns:

this

windowId

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

Sets the value of CfnMaintenanceWindowTaskMixinProps.getWindowId()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnMaintenanceWindowTaskMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnMaintenanceWindowTaskMixinProps

Throws:

NullPointerException - if any required attribute was not provided