Class CfnMaintenanceWindowTask
The AWS::SSM::MaintenanceWindowTask
resource defines information about a task for an AWS Systems Manager maintenance window.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.SSM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnMaintenanceWindowTask : CfnResource, IInspectable
Syntax (vb)
Public Class CfnMaintenanceWindowTask
Inherits CfnResource
Implements IInspectable
Remarks
For more information, see RegisterTaskWithMaintenanceWindow in the AWS Systems Manager API Reference .
CloudformationResource: AWS::SSM::MaintenanceWindowTask
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SSM;
var parameters;
var taskParameters;
var cfnMaintenanceWindowTask = new CfnMaintenanceWindowTask(this, "MyCfnMaintenanceWindowTask", new CfnMaintenanceWindowTaskProps {
Priority = 123,
TaskArn = "taskArn",
TaskType = "taskType",
WindowId = "windowId",
// the properties below are optional
CutoffBehavior = "cutoffBehavior",
Description = "description",
LoggingInfo = new LoggingInfoProperty {
Region = "region",
S3Bucket = "s3Bucket",
// the properties below are optional
S3Prefix = "s3Prefix"
},
MaxConcurrency = "maxConcurrency",
MaxErrors = "maxErrors",
Name = "name",
ServiceRoleArn = "serviceRoleArn",
Targets = new [] { new TargetProperty {
Key = "key",
Values = new [] { "values" }
} },
TaskInvocationParameters = new TaskInvocationParametersProperty {
MaintenanceWindowAutomationParameters = new MaintenanceWindowAutomationParametersProperty {
DocumentVersion = "documentVersion",
Parameters = parameters
},
MaintenanceWindowLambdaParameters = new MaintenanceWindowLambdaParametersProperty {
ClientContext = "clientContext",
Payload = "payload",
Qualifier = "qualifier"
},
MaintenanceWindowRunCommandParameters = new MaintenanceWindowRunCommandParametersProperty {
CloudWatchOutputConfig = new CloudWatchOutputConfigProperty {
CloudWatchLogGroupName = "cloudWatchLogGroupName",
CloudWatchOutputEnabled = false
},
Comment = "comment",
DocumentHash = "documentHash",
DocumentHashType = "documentHashType",
DocumentVersion = "documentVersion",
NotificationConfig = new NotificationConfigProperty {
NotificationArn = "notificationArn",
// the properties below are optional
NotificationEvents = new [] { "notificationEvents" },
NotificationType = "notificationType"
},
OutputS3BucketName = "outputS3BucketName",
OutputS3KeyPrefix = "outputS3KeyPrefix",
Parameters = parameters,
ServiceRoleArn = "serviceRoleArn",
TimeoutSeconds = 123
},
MaintenanceWindowStepFunctionsParameters = new MaintenanceWindowStepFunctionsParametersProperty {
Input = "input",
Name = "name"
}
},
TaskParameters = taskParameters
});
Synopsis
Constructors
CfnMaintenanceWindowTask(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnMaintenanceWindowTask(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnMaintenanceWindowTask(Construct, String, ICfnMaintenanceWindowTaskProps) |
Properties
AttrId | |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
CutoffBehavior | The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached. |
Description | A description of the task. |
LoggingInfo | Information about an Amazon S3 bucket to write Run Command task-level logs to. |
MaxConcurrency | The maximum number of targets this task can be run for, in parallel. |
MaxErrors | The maximum number of errors allowed before this task stops being scheduled. |
Name | The task name. |
Priority | The priority of the task in the maintenance window. |
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. |
Targets | The targets, either instances or window target IDs. |
TaskArn | The resource that the task uses during execution. |
TaskInvocationParameters | The parameters to pass to the task when it runs. |
TaskParameters | The parameters to pass to the task when it runs. |
TaskType | The type of task. |
WindowId | The ID of the maintenance window where the task is registered. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnMaintenanceWindowTask(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnMaintenanceWindowTask(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnMaintenanceWindowTask(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnMaintenanceWindowTask(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnMaintenanceWindowTask(Construct, String, ICfnMaintenanceWindowTaskProps)
public CfnMaintenanceWindowTask(Construct scope, string id, ICfnMaintenanceWindowTaskProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnMaintenanceWindowTaskProps
Resource properties.
Properties
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
CutoffBehavior
The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
public virtual string CutoffBehavior { get; set; }
Property Value
System.String
Description
A description of the task.
public virtual string Description { get; set; }
Property Value
System.String
LoggingInfo
Information about an Amazon S3 bucket to write Run Command task-level logs to.
public virtual object LoggingInfo { get; set; }
Property Value
System.Object
MaxConcurrency
The maximum number of targets this task can be run for, in parallel.
public virtual string MaxConcurrency { get; set; }
Property Value
System.String
MaxErrors
The maximum number of errors allowed before this task stops being scheduled.
public virtual string MaxErrors { get; set; }
Property Value
System.String
Name
The task name.
public virtual string Name { get; set; }
Property Value
System.String
Priority
The priority of the task in the maintenance window.
public virtual double Priority { get; set; }
Property Value
System.Double
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.
public virtual string ServiceRoleArn { get; set; }
Property Value
System.String
Targets
The targets, either instances or window target IDs.
public virtual object Targets { get; set; }
Property Value
System.Object
TaskArn
The resource that the task uses during execution.
public virtual string TaskArn { get; set; }
Property Value
System.String
TaskInvocationParameters
The parameters to pass to the task when it runs.
public virtual object TaskInvocationParameters { get; set; }
Property Value
System.Object
TaskParameters
The parameters to pass to the task when it runs.
public virtual object TaskParameters { get; set; }
Property Value
System.Object
TaskType
The type of task.
public virtual string TaskType { get; set; }
Property Value
System.String
WindowId
The ID of the maintenance window where the task is registered.
public virtual string WindowId { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>