Class CfnMaintenanceWindowTarget
The AWS::SSM::MaintenanceWindowTarget
resource registers a target with a maintenance window for AWS Systems Manager .
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.SSM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnMaintenanceWindowTarget : CfnResource, IInspectable
Syntax (vb)
Public Class CfnMaintenanceWindowTarget Inherits CfnResource Implements IInspectable
Remarks
For more information, see RegisterTargetWithMaintenanceWindow in the AWS Systems Manager API Reference .
CloudformationResource: AWS::SSM::MaintenanceWindowTarget
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 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) | The |
Properties
AttrId | The |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | The |
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>) | The |
Constructors
CfnMaintenanceWindowTarget(Construct, string, ICfnMaintenanceWindowTargetProps)
The AWS::SSM::MaintenanceWindowTarget
resource registers a target with a maintenance window for AWS Systems Manager .
public CfnMaintenanceWindowTarget(Construct scope, string id, ICfnMaintenanceWindowTargetProps props)
Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnMaintenanceWindowTargetProps
Resource properties.
Remarks
For more information, see RegisterTargetWithMaintenanceWindow in the AWS Systems Manager API Reference .
CloudformationResource: AWS::SSM::MaintenanceWindowTarget
ExampleMetadata: fixture=_generated
Properties
AttrId
The AWS::SSM::MaintenanceWindowTarget
resource registers a target with a maintenance window for AWS Systems Manager .
public virtual string AttrId { get; }
Property Value
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
Remarks
For more information, see RegisterTargetWithMaintenanceWindow in the AWS Systems Manager API Reference .
CloudformationResource: AWS::SSM::MaintenanceWindowTarget
ExampleMetadata: fixture=_generated
CfnProperties
The AWS::SSM::MaintenanceWindowTarget
resource registers a target with a maintenance window for AWS Systems Manager .
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
For more information, see RegisterTargetWithMaintenanceWindow in the AWS Systems Manager API Reference .
CloudformationResource: AWS::SSM::MaintenanceWindowTarget
ExampleMetadata: fixture=_generated
Description
A description for the target.
public virtual string? Description { get; set; }
Property Value
Remarks
For more information, see RegisterTargetWithMaintenanceWindow in the AWS Systems Manager API Reference .
CloudformationResource: AWS::SSM::MaintenanceWindowTarget
ExampleMetadata: fixture=_generated
Name
The name for the maintenance window target.
public virtual string? Name { get; set; }
Property Value
Remarks
For more information, see RegisterTargetWithMaintenanceWindow in the AWS Systems Manager API Reference .
CloudformationResource: AWS::SSM::MaintenanceWindowTarget
ExampleMetadata: fixture=_generated
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
Remarks
For more information, see RegisterTargetWithMaintenanceWindow in the AWS Systems Manager API Reference .
CloudformationResource: AWS::SSM::MaintenanceWindowTarget
ExampleMetadata: fixture=_generated
ResourceType
The type of target that is being registered with the maintenance window.
public virtual string ResourceType { get; set; }
Property Value
Remarks
For more information, see RegisterTargetWithMaintenanceWindow in the AWS Systems Manager API Reference .
CloudformationResource: AWS::SSM::MaintenanceWindowTarget
ExampleMetadata: fixture=_generated
Targets
The targets to register with the maintenance window.
public virtual object Targets { get; set; }
Property Value
Remarks
For more information, see RegisterTargetWithMaintenanceWindow in the AWS Systems Manager API Reference .
CloudformationResource: AWS::SSM::MaintenanceWindowTarget
ExampleMetadata: fixture=_generated
WindowId
The ID of the maintenance window to register the target with.
public virtual string WindowId { get; set; }
Property Value
Remarks
For more information, see RegisterTargetWithMaintenanceWindow in the AWS Systems Manager API Reference .
CloudformationResource: AWS::SSM::MaintenanceWindowTarget
ExampleMetadata: fixture=_generated
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.
Remarks
For more information, see RegisterTargetWithMaintenanceWindow in the AWS Systems Manager API Reference .
CloudformationResource: AWS::SSM::MaintenanceWindowTarget
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
The AWS::SSM::MaintenanceWindowTarget
resource registers a target with a maintenance window for AWS Systems Manager .
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
For more information, see RegisterTargetWithMaintenanceWindow in the AWS Systems Manager API Reference .
CloudformationResource: AWS::SSM::MaintenanceWindowTarget
ExampleMetadata: fixture=_generated