Class CfnMaintenanceWindowTarget

Namespace

Amazon.CDK.AWS.SSM

Assembly

Amazon.CDK.AWS.SSM.dll

A CloudFormation AWS::SSM::MaintenanceWindowTarget.

public class CfnMaintenanceWindowTarget : CfnResource, IInspectable

Inheritance

object

CfnMaintenanceWindowTarget

Implements

IInspectable

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 cfnMaintenanceWindowTarget = new CfnMaintenanceWindowTarget(this, "MyCfnMaintenanceWindowTarget", new CfnMaintenanceWindowTargetProps {
                 ResourceType = "resourceType",
                 Targets = new [] { new TargetsProperty {
                     Key = "key",
                     Values = new [] { "values" }
                 } },
                 WindowId = "windowId",

                 // the properties below are optional
                 Description = "description",
                 Name = "name",
                 OwnerInformation = "ownerInformation"
             });

Remarks

The AWS::SSM::MaintenanceWindowTarget resource registers a target with a maintenance window for AWS Systems Manager . For more information, see RegisterTargetWithMaintenanceWindow in the AWS Systems Manager API Reference .

CloudformationResource: AWS::SSM::MaintenanceWindowTarget

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html

ExampleMetadata: fixture=_generated

Constructors

CfnMaintenanceWindowTarget(Construct, string, ICfnMaintenanceWindowTargetProps)

Create a new AWS::SSM::MaintenanceWindowTarget.

public CfnMaintenanceWindowTarget(Construct scope, string id, ICfnMaintenanceWindowTargetProps props)

Parameters

scope Construct

• scope in which this resource is defined.

id string

• scoped id of the resource.

props ICfnMaintenanceWindowTargetProps

• resource properties.

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Description

A description for the target.

public virtual string? Description { get; set; }

Property Value

string

Remarks

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

Name

The name for the maintenance window target.

public virtual string? Name { get; set; }

Property Value

string

Remarks

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

OwnerInformation

A user-provided value that will be included in any Amazon CloudWatch Events events that are raised while running tasks for these targets in this maintenance window.

public virtual string? OwnerInformation { get; set; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-ownerinformation

ResourceType

The type of target that is being registered with the maintenance window.

public virtual string ResourceType { get; set; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-resourcetype

Targets

The targets to register with the maintenance window.

public virtual object Targets { get; set; }

Property Value

object

Remarks

In other words, the instances to run commands on when the maintenance window runs.

You must specify targets by using the WindowTargetIds parameter.

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

WindowId

The ID of the maintenance window to register the target with.

public virtual string WindowId { get; set; }

Property Value

string

Remarks

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

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 IDictionary<string, object>

Returns

IDictionary<string, object>