Show / Hide Table of Contents

Class CfnMaintenanceWindowTarget

A CloudFormation AWS::SSM::MaintenanceWindowTarget.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnMaintenanceWindowTarget
Implements
IConstruct
Constructs.IConstruct
IDependable
IInspectable
Inherited Members
CfnResource.IsCfnResource(IConstruct)
CfnResource.AddDeletionOverride(String)
CfnResource.AddDependsOn(CfnResource)
CfnResource.AddMetadata(String, Object)
CfnResource.AddOverride(String, Object)
CfnResource.AddPropertyDeletionOverride(String)
CfnResource.AddPropertyOverride(String, Object)
CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)
CfnResource.GetAtt(String)
CfnResource.GetMetadata(String)
CfnResource.ShouldSynthesize()
CfnResource.ToString()
CfnResource.ValidateProperties(Object)
CfnResource.CfnOptions
CfnResource.CfnResourceType
CfnResource.UpdatedProperites
CfnRefElement.Ref
CfnElement.IsCfnElement(Object)
CfnElement.OverrideLogicalId(String)
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Construct.IsConstruct(Object)
Construct.OnPrepare()
Construct.OnSynthesize(ISynthesisSession)
Construct.OnValidate()
Construct.Prepare()
Construct.Synthesize(ISynthesisSession)
Construct.Validate()
Construct.Node
Namespace: Amazon.CDK.AWS.SSM
Assembly: Amazon.CDK.AWS.SSM.dll
Syntax (csharp)
public class CfnMaintenanceWindowTarget : CfnResource, IConstruct, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnMaintenanceWindowTarget
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable
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

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;

CfnMaintenanceWindowTarget 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"
});

Synopsis

Constructors

CfnMaintenanceWindowTarget(Construct, String, ICfnMaintenanceWindowTargetProps)

Create a new AWS::SSM::MaintenanceWindowTarget.

CfnMaintenanceWindowTarget(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

CfnMaintenanceWindowTarget(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

CfnProperties
Description

A description for the target.

Name

The name for the maintenance window target.

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.

ResourceType

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

Targets

The targets to register with the maintenance window.

WindowId

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

RenderProperties(IDictionary<String, Object>)

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 System.String
  • scoped id of the resource.
props ICfnMaintenanceWindowTargetProps
  • resource properties.

CfnMaintenanceWindowTarget(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnMaintenanceWindowTarget(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnMaintenanceWindowTarget(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnMaintenanceWindowTarget(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

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
CfnResource.CfnProperties

Description

A description for the target.

public virtual string Description { get; set; }
Property Value

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

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

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

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

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

System.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 System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides
CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IConstruct
Constructs.IConstruct
IDependable
IInspectable
Back to top Generated by DocFX