Package software.amazon.awscdk.services.ssm

Class CfnMaintenanceWindowTaskProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ssm.CfnMaintenanceWindowTaskProps.Jsii$Proxy

All Implemented Interfaces:

CfnMaintenanceWindowTaskProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnMaintenanceWindowTaskProps

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

An implementation for CfnMaintenanceWindowTaskProps

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.CfnMaintenanceWindowTaskProps

CfnMaintenanceWindowTaskProps.Builder, CfnMaintenanceWindowTaskProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnMaintenanceWindowTaskProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnMaintenanceWindowTaskProps.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 String	getCutoffBehavior()	The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
final String	getDescription()	A description of the task.
final Object	getLoggingInfo()
final String	getMaxConcurrency()	The maximum number of targets this task can be run for, in parallel.
final String	getMaxErrors()	The maximum number of errors allowed before this task stops being scheduled.
final String	getName()	The task name.
final Number	getPriority()	The priority of the task in the maintenance window.
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 Object	getTargets()	The targets, either instances or window target IDs.
final String	getTaskArn()	The resource that the task uses during execution.
final Object	getTaskInvocationParameters()	The parameters to pass to the task when it runs.
final Object	getTaskParameters()
final String	getTaskType()	The type of task.
final String	getWindowId()	The ID of the maintenance window where the task is registered.
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(CfnMaintenanceWindowTaskProps.Builder builder)

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

Method Details

getPriority

public final Number getPriority()

Description copied from interface: CfnMaintenanceWindowTaskProps

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.

Specified by:

getPriority in interface CfnMaintenanceWindowTaskProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-priority

getTaskArn

public final String getTaskArn()

Description copied from interface: CfnMaintenanceWindowTaskProps

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.

Specified by:

getTaskArn in interface CfnMaintenanceWindowTaskProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskarn

getTaskType

public final String getTaskType()

Description copied from interface: CfnMaintenanceWindowTaskProps

The type of task.

Valid values: RUN_COMMAND , AUTOMATION , LAMBDA , STEP_FUNCTIONS .

Specified by:

getTaskType in interface CfnMaintenanceWindowTaskProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-tasktype

getWindowId

public final String getWindowId()

Description copied from interface: CfnMaintenanceWindowTaskProps

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

Specified by:

getWindowId in interface CfnMaintenanceWindowTaskProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-windowid

getCutoffBehavior

public final String getCutoffBehavior()

Description copied from interface: CfnMaintenanceWindowTaskProps

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

Specified by:

getCutoffBehavior in interface CfnMaintenanceWindowTaskProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-cutoffbehavior

getDescription

public final String getDescription()

Description copied from interface: CfnMaintenanceWindowTaskProps

A description of the task.

Specified by:

getDescription in interface CfnMaintenanceWindowTaskProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-description

getLoggingInfo

public final Object getLoggingInfo()

Description copied from interface: CfnMaintenanceWindowTaskProps

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 union: either IResolvable or CfnMaintenanceWindowTask.LoggingInfoProperty

Specified by:

getLoggingInfo in interface CfnMaintenanceWindowTaskProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-logginginfo

getMaxConcurrency

public final String getMaxConcurrency()

Description copied from interface: CfnMaintenanceWindowTaskProps

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.

Specified by:

getMaxConcurrency in interface CfnMaintenanceWindowTaskProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-maxconcurrency

getMaxErrors

public final String getMaxErrors()

Description copied from interface: CfnMaintenanceWindowTaskProps

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.

Specified by:

getMaxErrors in interface CfnMaintenanceWindowTaskProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-maxerrors

getName

public final String getName()

Description copied from interface: CfnMaintenanceWindowTaskProps

The task name.

Specified by:

getName in interface CfnMaintenanceWindowTaskProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-name

getServiceRoleArn

public final String getServiceRoleArn()

Description copied from interface: CfnMaintenanceWindowTaskProps

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 CfnMaintenanceWindowTaskProps

See Also:

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

getTargets

public final Object getTargets()

Description copied from interface: CfnMaintenanceWindowTaskProps

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 union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnMaintenanceWindowTask.TargetProperty>

Specified by:

getTargets in interface CfnMaintenanceWindowTaskProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-targets

getTaskInvocationParameters

public final Object getTaskInvocationParameters()

Description copied from interface: CfnMaintenanceWindowTaskProps

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 union: either IResolvable or CfnMaintenanceWindowTask.TaskInvocationParametersProperty

Specified by:

getTaskInvocationParameters in interface CfnMaintenanceWindowTaskProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters

getTaskParameters

public final Object getTaskParameters()

Description copied from interface: CfnMaintenanceWindowTaskProps

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.

Specified by:

getTaskParameters in interface CfnMaintenanceWindowTaskProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskparameters

$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