Class CfnResponsePlan
The AWS::SSMIncidents::ResponsePlan
resource specifies the details of the response plan that are used when creating an incident.
Inherited Members
Namespace: Amazon.CDK.AWS.SSMIncidents
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnResponsePlan : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnResponsePlan
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
CloudformationResource: AWS::SSMIncidents::ResponsePlan
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.SSMIncidents;
var cfnResponsePlan = new CfnResponsePlan(this, "MyCfnResponsePlan", new CfnResponsePlanProps {
IncidentTemplate = new IncidentTemplateProperty {
Impact = 123,
Title = "title",
// the properties below are optional
DedupeString = "dedupeString",
IncidentTags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
NotificationTargets = new [] { new NotificationTargetItemProperty {
SnsTopicArn = "snsTopicArn"
} },
Summary = "summary"
},
Name = "name",
// the properties below are optional
Actions = new [] { new ActionProperty {
SsmAutomation = new SsmAutomationProperty {
DocumentName = "documentName",
RoleArn = "roleArn",
// the properties below are optional
DocumentVersion = "documentVersion",
DynamicParameters = new [] { new DynamicSsmParameterProperty {
Key = "key",
Value = new DynamicSsmParameterValueProperty {
Variable = "variable"
}
} },
Parameters = new [] { new SsmParameterProperty {
Key = "key",
Values = new [] { "values" }
} },
TargetAccount = "targetAccount"
}
} },
ChatChannel = new ChatChannelProperty {
ChatbotSns = new [] { "chatbotSns" }
},
DisplayName = "displayName",
Engagements = new [] { "engagements" },
Integrations = new [] { new IntegrationProperty {
PagerDutyConfiguration = new PagerDutyConfigurationProperty {
Name = "name",
PagerDutyIncidentConfiguration = new PagerDutyIncidentConfigurationProperty {
ServiceId = "serviceId"
},
SecretId = "secretId"
}
} },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnResponsePlan(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnResponsePlan(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnResponsePlan(Construct, String, ICfnResponsePlanProps) |
Properties
Actions | The actions that the response plan starts at the beginning of an incident. |
AttrArn | The ARN of the response plan. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ChatChannel | The AWS Chatbot chat channel used for collaboration during an incident. |
DisplayName | The human readable name of the response plan. |
Engagements | The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident. |
IncidentTemplate | Details used to create an incident when using this response plan. |
Integrations | Information about third-party services integrated into the response plan. |
Name | The name of the response plan. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | An array of key-value pairs to apply to this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnResponsePlan(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnResponsePlan(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnResponsePlan(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnResponsePlan(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnResponsePlan(Construct, String, ICfnResponsePlanProps)
public CfnResponsePlan(Construct scope, string id, ICfnResponsePlanProps 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 ICfnResponsePlanProps
Resource properties.
Properties
Actions
The actions that the response plan starts at the beginning of an incident.
public virtual object Actions { get; set; }
Property Value
System.Object
AttrArn
The ARN of the response plan.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
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
ChatChannel
The AWS Chatbot chat channel used for collaboration during an incident.
public virtual object ChatChannel { get; set; }
Property Value
System.Object
DisplayName
The human readable name of the response plan.
public virtual string DisplayName { get; set; }
Property Value
System.String
Engagements
The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.
public virtual string[] Engagements { get; set; }
Property Value
System.String[]
IncidentTemplate
Details used to create an incident when using this response plan.
public virtual object IncidentTemplate { get; set; }
Property Value
System.Object
Integrations
Information about third-party services integrated into the response plan.
public virtual object Integrations { get; set; }
Property Value
System.Object
Name
The name of the response plan.
public virtual string Name { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
An array of key-value pairs to apply to this resource.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
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>