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

Class CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.ssm.CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty>

Enclosing interface:

CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty

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

A builder for CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty	build()	Builds the configured instance.
CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder	cloudWatchOutputConfig(CfnMaintenanceWindowTaskPropsMixin.CloudWatchOutputConfigProperty cloudWatchOutputConfig)	Sets the value of CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.getCloudWatchOutputConfig()
CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder	cloudWatchOutputConfig(IResolvable cloudWatchOutputConfig)	Sets the value of CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.getCloudWatchOutputConfig()
CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder	comment(String comment)	Sets the value of CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.getComment()
CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder	documentHash(String documentHash)	Sets the value of CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.getDocumentHash()
CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder	documentHashType(String documentHashType)	Sets the value of CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.getDocumentHashType()
CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder	documentVersion(String documentVersion)	Sets the value of CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.getDocumentVersion()
CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder	notificationConfig(CfnMaintenanceWindowTaskPropsMixin.NotificationConfigProperty notificationConfig)	Sets the value of CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.getNotificationConfig()
CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder	notificationConfig(IResolvable notificationConfig)	Sets the value of CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.getNotificationConfig()
CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder	outputS3BucketName(String outputS3BucketName)	Sets the value of CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.getOutputS3BucketName()
CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder	outputS3KeyPrefix(String outputS3KeyPrefix)	Sets the value of CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.getOutputS3KeyPrefix()
CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder	parameters(Object parameters)	Sets the value of CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.getParameters()
CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder	serviceRoleArn(String serviceRoleArn)	Sets the value of CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.getServiceRoleArn()
CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder	timeoutSeconds(Number timeoutSeconds)	Sets the value of CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.getTimeoutSeconds()

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

cloudWatchOutputConfig

@Stability(Stable)
public CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder cloudWatchOutputConfig(IResolvable cloudWatchOutputConfig)

Sets the value of CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.getCloudWatchOutputConfig()

Parameters:

cloudWatchOutputConfig - Configuration options for sending command output to Amazon CloudWatch Logs.

Returns:

this

cloudWatchOutputConfig

@Stability(Stable)
public CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder cloudWatchOutputConfig(CfnMaintenanceWindowTaskPropsMixin.CloudWatchOutputConfigProperty cloudWatchOutputConfig)

Sets the value of CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.getCloudWatchOutputConfig()

Parameters:

cloudWatchOutputConfig - Configuration options for sending command output to Amazon CloudWatch Logs.

Returns:

this

comment

@Stability(Stable)
public CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder comment(String comment)

Sets the value of CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.getComment()

Parameters:

comment - Information about the command or commands to run.

Returns:

this

documentHash

@Stability(Stable)
public CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder documentHash(String documentHash)

Sets the value of CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.getDocumentHash()

Parameters:

documentHash - The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.

Returns:

this

documentHashType

@Stability(Stable)
public CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder documentHashType(String documentHashType)

Sets the value of CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.getDocumentHashType()

Parameters:

documentHashType - The SHA-256 or SHA-1 hash type. SHA-1 hashes are deprecated.

Returns:

this

documentVersion

@Stability(Stable)
public CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder documentVersion(String documentVersion)

Sets the value of CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.getDocumentVersion()

Parameters:

documentVersion - The AWS Systems Manager document (SSM document) version to use in the request. You can specify $DEFAULT , $LATEST , or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

--document-version "\$DEFAULT"

--document-version "\$LATEST"

--document-version "3"

Returns:

this

notificationConfig

@Stability(Stable)
public CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder notificationConfig(IResolvable notificationConfig)

Sets the value of CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.getNotificationConfig()

Parameters:

notificationConfig - Configurations for sending notifications about command status changes on a per-managed node basis.

Returns:

this

notificationConfig

@Stability(Stable)
public CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder notificationConfig(CfnMaintenanceWindowTaskPropsMixin.NotificationConfigProperty notificationConfig)

Sets the value of CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.getNotificationConfig()

Parameters:

notificationConfig - Configurations for sending notifications about command status changes on a per-managed node basis.

Returns:

this

outputS3BucketName

@Stability(Stable)
public CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder outputS3BucketName(String outputS3BucketName)

Sets the value of CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.getOutputS3BucketName()

Parameters:

outputS3BucketName - The name of the Amazon Simple Storage Service (Amazon S3) bucket.

Returns:

this

outputS3KeyPrefix

@Stability(Stable)
public CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder outputS3KeyPrefix(String outputS3KeyPrefix)

Sets the value of CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.getOutputS3KeyPrefix()

Parameters:

outputS3KeyPrefix - The S3 bucket subfolder.

Returns:

this

parameters

@Stability(Stable)
public CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder parameters(Object parameters)

Sets the value of CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.getParameters()

Parameters:

parameters - The parameters for the RUN_COMMAND task execution. The supported parameters are the same as those for the SendCommand API call. For more information, see SendCommand in the AWS Systems Manager API Reference .

Returns:

this

serviceRoleArn

@Stability(Stable)
public CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder serviceRoleArn(String serviceRoleArn)

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

timeoutSeconds

@Stability(Stable)
public CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.Builder timeoutSeconds(Number timeoutSeconds)

Sets the value of CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty.getTimeoutSeconds()

Parameters:

timeoutSeconds - If this time is reached and the command hasn't already started running, it doesn't run.

Returns:

this

build

@Stability(Stable)
public CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty>

Returns:

a new instance of CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty

Throws:

NullPointerException - if any required attribute was not provided