Package software.amazon.awscdk.services.ssm

Class CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ssm.CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty.Jsii$Proxy

All Implemented Interfaces:

CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

@Stability(Stable)
@Internal
public static final class CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

An implementation for CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ssm.CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty.Builder, CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getCloudWatchOutputConfig()	Configuration options for sending command output to Amazon CloudWatch Logs.
final String	getComment()	Information about the command or commands to run.
final String	getDocumentHash()	The SHA-256 or SHA-1 hash created by the system when the document was created.
final String	getDocumentHashType()	The SHA-256 or SHA-1 hash type.
final String	getDocumentVersion()	The AWS Systems Manager document (SSM document) version to use in the request.
final Object	getNotificationConfig()	Configurations for sending notifications about command status changes on a per-managed node basis.
final String	getOutputS3BucketName()	The name of the Amazon Simple Storage Service (Amazon S3) bucket.
final String	getOutputS3KeyPrefix()	The S3 bucket subfolder.
final Object	getParameters()	The parameters for the RUN_COMMAND task execution.
final String	getServiceRoleArn()	The Amazon Resource Name (ARN) of the IAM service role for AWS Systems Manager to assume when running a maintenance window task.
final Number	getTimeoutSeconds()	If this time is reached and the command hasn't already started running, it doesn't run.
final int	hashCode()

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty.Builder.

Method Details

getCloudWatchOutputConfig

public final Object getCloudWatchOutputConfig()

Description copied from interface: CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

Configuration options for sending command output to Amazon CloudWatch Logs.

Returns union: either IResolvable or CfnMaintenanceWindowTask.CloudWatchOutputConfigProperty

Specified by:

getCloudWatchOutputConfig in interface CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-cloudwatchoutputconfig

getComment

public final String getComment()

Description copied from interface: CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

Information about the command or commands to run.

Specified by:

getComment in interface CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-comment

getDocumentHash

public final String getDocumentHash()

Description copied from interface: CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

The SHA-256 or SHA-1 hash created by the system when the document was created.

SHA-1 hashes have been deprecated.

Specified by:

getDocumentHash in interface CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-documenthash

getDocumentHashType

public final String getDocumentHashType()

Description copied from interface: CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

The SHA-256 or SHA-1 hash type.

SHA-1 hashes are deprecated.

Specified by:

getDocumentHashType in interface CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-documenthashtype

getDocumentVersion

public final String getDocumentVersion()

Description copied from interface: CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

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"

Specified by:

getDocumentVersion in interface CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-documentversion

getNotificationConfig

public final Object getNotificationConfig()

Description copied from interface: CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

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

Returns union: either IResolvable or CfnMaintenanceWindowTask.NotificationConfigProperty

Specified by:

getNotificationConfig in interface CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-notificationconfig

getOutputS3BucketName

public final String getOutputS3BucketName()

Description copied from interface: CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

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

Specified by:

getOutputS3BucketName in interface CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-outputs3bucketname

getOutputS3KeyPrefix

public final String getOutputS3KeyPrefix()

Description copied from interface: CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

The S3 bucket subfolder.

Specified by:

getOutputS3KeyPrefix in interface CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-outputs3keyprefix

getParameters

public final Object getParameters()

Description copied from interface: CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

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 .

Specified by:

getParameters in interface CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-parameters

getServiceRoleArn

public final String getServiceRoleArn()

Description copied from interface: CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

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 .

Specified by:

getServiceRoleArn in interface CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-servicerolearn

getTimeoutSeconds

public final Number getTimeoutSeconds()

Description copied from interface: CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

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

Specified by:

getTimeoutSeconds in interface CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-timeoutseconds

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object