awsssmincidents

Documentation

Index

• func CfnReplicationSet_CFN_RESOURCE_TYPE_NAME() *string
• func CfnReplicationSet_IsCfnElement(x interface{}) *bool
• func CfnReplicationSet_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnReplicationSet_IsConstruct(x interface{}) *bool
• func CfnResponsePlan_CFN_RESOURCE_TYPE_NAME() *string
• func CfnResponsePlan_IsCfnElement(x interface{}) *bool
• func CfnResponsePlan_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnResponsePlan_IsConstruct(x interface{}) *bool
• func NewCfnReplicationSet_Override(c CfnReplicationSet, scope awscdk.Construct, id *string, ...)
• func NewCfnResponsePlan_Override(c CfnResponsePlan, scope awscdk.Construct, id *string, ...)
• type CfnReplicationSet
  • func NewCfnReplicationSet(scope awscdk.Construct, id *string, props *CfnReplicationSetProps) CfnReplicationSet
• type CfnReplicationSetProps
• type CfnReplicationSet_RegionConfigurationProperty
• type CfnReplicationSet_ReplicationRegionProperty
• type CfnResponsePlan
  • func NewCfnResponsePlan(scope awscdk.Construct, id *string, props *CfnResponsePlanProps) CfnResponsePlan
• type CfnResponsePlanProps
• type CfnResponsePlan_ActionProperty
• type CfnResponsePlan_ChatChannelProperty
• type CfnResponsePlan_IncidentTemplateProperty
• type CfnResponsePlan_NotificationTargetItemProperty
• type CfnResponsePlan_SsmAutomationProperty
• type CfnResponsePlan_SsmParameterProperty

Functions

func CfnReplicationSet_CFN_RESOURCE_TYPE_NAME

func CfnReplicationSet_CFN_RESOURCE_TYPE_NAME() *string

func CfnReplicationSet_IsCfnElement

func CfnReplicationSet_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnReplicationSet_IsCfnResource

func CfnReplicationSet_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnReplicationSet_IsConstruct

func CfnReplicationSet_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnResponsePlan_CFN_RESOURCE_TYPE_NAME

func CfnResponsePlan_CFN_RESOURCE_TYPE_NAME() *string

func CfnResponsePlan_IsCfnElement

func CfnResponsePlan_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnResponsePlan_IsCfnResource

func CfnResponsePlan_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnResponsePlan_IsConstruct

func CfnResponsePlan_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func NewCfnReplicationSet_Override

func NewCfnReplicationSet_Override(c CfnReplicationSet, scope awscdk.Construct, id *string, props *CfnReplicationSetProps)

Create a new `AWS::SSMIncidents::ReplicationSet`.

func NewCfnResponsePlan_Override

func NewCfnResponsePlan_Override(c CfnResponsePlan, scope awscdk.Construct, id *string, props *CfnResponsePlanProps)

Create a new `AWS::SSMIncidents::ResponsePlan`.

Types

type CfnReplicationSet

type CfnReplicationSet interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DeletionProtected() interface{}
	SetDeletionProtected(val interface{})
	LogicalId() *string
	Node() awscdk.ConstructNode
	Ref() *string
	Regions() interface{}
	SetRegions(val interface{})
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SSMIncidents::ReplicationSet`.

The `AWS::SSMIncidents::ReplicationSet` resource specifies a set of Regions that Incident Manager data is replicated to and the KMS key used to encrypt the data.

TODO: EXAMPLE

func NewCfnReplicationSet

func NewCfnReplicationSet(scope awscdk.Construct, id *string, props *CfnReplicationSetProps) CfnReplicationSet

Create a new `AWS::SSMIncidents::ReplicationSet`.

type CfnReplicationSetProps

type CfnReplicationSetProps struct {
	// Specifies the Regions of the replication set.
	Regions interface{} `json:"regions" yaml:"regions"`
	// Determines if the replication set deletion protection is enabled or not.
	//
	// If deletion protection is enabled, you can't delete the last Region in the replication set.
	DeletionProtected interface{} `json:"deletionProtected" yaml:"deletionProtected"`
}

Properties for defining a `CfnReplicationSet`.

TODO: EXAMPLE

type CfnReplicationSet_RegionConfigurationProperty

type CfnReplicationSet_RegionConfigurationProperty struct {
	// The KMS key ID to use to encrypt your replication set.
	SseKmsKeyId *string `json:"sseKmsKeyId" yaml:"sseKmsKeyId"`
}

The `RegionConfiguration` property specifies the Region and KMS key to add to the replication set.

TODO: EXAMPLE

type CfnReplicationSet_ReplicationRegionProperty

type CfnReplicationSet_ReplicationRegionProperty struct {
	// Specifies the Region configuration.
	RegionConfiguration interface{} `json:"regionConfiguration" yaml:"regionConfiguration"`
	// Specifies the region name to add to the replication set.
	RegionName *string `json:"regionName" yaml:"regionName"`
}

The `ReplicationRegion` property type specifies the Region and KMS key to add to the replication set.

TODO: EXAMPLE

type CfnResponsePlan

type CfnResponsePlan interface {
	awscdk.CfnResource
	awscdk.IInspectable
	Actions() interface{}
	SetActions(val interface{})
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ChatChannel() interface{}
	SetChatChannel(val interface{})
	CreationStack() *[]*string
	DisplayName() *string
	SetDisplayName(val *string)
	Engagements() *[]*string
	SetEngagements(val *[]*string)
	IncidentTemplate() interface{}
	SetIncidentTemplate(val interface{})
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SSMIncidents::ResponsePlan`.

The `AWS::SSMIncidents::ResponsePlan` resource specifies the details of the response plan that are used when creating an incident.

TODO: EXAMPLE

func NewCfnResponsePlan

func NewCfnResponsePlan(scope awscdk.Construct, id *string, props *CfnResponsePlanProps) CfnResponsePlan

Create a new `AWS::SSMIncidents::ResponsePlan`.

type CfnResponsePlanProps

type CfnResponsePlanProps struct {
	// Details used to create an incident when using this response plan.
	IncidentTemplate interface{} `json:"incidentTemplate" yaml:"incidentTemplate"`
	// The name of the response plan.
	Name *string `json:"name" yaml:"name"`
	// The actions that the response plan starts at the beginning of an incident.
	Actions interface{} `json:"actions" yaml:"actions"`
	// The AWS Chatbot chat channel used for collaboration during an incident.
	ChatChannel interface{} `json:"chatChannel" yaml:"chatChannel"`
	// The human readable name of the response plan.
	DisplayName *string `json:"displayName" yaml:"displayName"`
	// The contacts and escalation plans that the response plan engages during an incident.
	Engagements *[]*string `json:"engagements" yaml:"engagements"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnResponsePlan`.

TODO: EXAMPLE

type CfnResponsePlan_ActionProperty

type CfnResponsePlan_ActionProperty struct {
	// Details about the Systems Manager automation document that will be used as a runbook during an incident.
	SsmAutomation interface{} `json:"ssmAutomation" yaml:"ssmAutomation"`
}

The `Action` property type specifies the configuration to launch.

TODO: EXAMPLE

type CfnResponsePlan_ChatChannelProperty

type CfnResponsePlan_ChatChannelProperty struct {
	// The SNS targets that AWS Chatbot uses to notify the chat channel of updates to an incident.
	//
	// You can also make updates to the incident through the chat channel by using the SNS topics
	ChatbotSns *[]*string `json:"chatbotSns" yaml:"chatbotSns"`
}

The AWS Chatbot chat channel used for collaboration during an incident.

TODO: EXAMPLE

type CfnResponsePlan_IncidentTemplateProperty

type CfnResponsePlan_IncidentTemplateProperty struct {
	// Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.
	//
	// **Possible impacts:** - `1` - Critical impact, this typically relates to full application failure that impacts many to all customers.
	// - `2` - High impact, partial application failure with impact to many customers.
	// - `3` - Medium impact, the application is providing reduced service to customers.
	// - `4` - Low impact, customer might aren't impacted by the problem yet.
	// - `5` - No impact, customers aren't currently impacted but urgent action is needed to avoid impact.
	Impact *float64 `json:"impact" yaml:"impact"`
	// The title of the incident is a brief and easily recognizable.
	Title *string `json:"title" yaml:"title"`
	// Used to create only one incident record for an incident.
	DedupeString *string `json:"dedupeString" yaml:"dedupeString"`
	// The SNS targets that AWS Chatbot uses to notify the chat channel of updates to an incident.
	//
	// You can also make updates to the incident through the chat channel using the SNS topics.
	NotificationTargets interface{} `json:"notificationTargets" yaml:"notificationTargets"`
	// The summary describes what has happened during the incident.
	Summary *string `json:"summary" yaml:"summary"`
}

The `IncidentTemplate` property type specifies details used to create an incident when using this response plan.

TODO: EXAMPLE

type CfnResponsePlan_NotificationTargetItemProperty

type CfnResponsePlan_NotificationTargetItemProperty struct {
	// The Amazon Resource Name (ARN) of the SNS topic.
	SnsTopicArn *string `json:"snsTopicArn" yaml:"snsTopicArn"`
}

The SNS topic that's used by AWS Chatbot to notify the incidents chat channel.

TODO: EXAMPLE

type CfnResponsePlan_SsmAutomationProperty

type CfnResponsePlan_SsmAutomationProperty struct {
	// The automation document's name.
	DocumentName *string `json:"documentName" yaml:"documentName"`
	// The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
	RoleArn *string `json:"roleArn" yaml:"roleArn"`
	// The automation document's version to use when running.
	DocumentVersion *string `json:"documentVersion" yaml:"documentVersion"`
	// The key-value pair parameters to use when running the automation document.
	Parameters interface{} `json:"parameters" yaml:"parameters"`
	// The account that the automation document will be run in.
	//
	// This can be in either the management account or an application account.
	TargetAccount *string `json:"targetAccount" yaml:"targetAccount"`
}

The `SsmAutomation` property type specifies details about the Systems Manager automation document that will be used as a runbook during an incident.

TODO: EXAMPLE

type CfnResponsePlan_SsmParameterProperty

type CfnResponsePlan_SsmParameterProperty struct {
	// The key parameter to use when running the automation document.
	Key *string `json:"key" yaml:"key"`
	// The value parameter to use when running the automation document.
	Values *[]*string `json:"values" yaml:"values"`
}

The key-value pair parameters to use when running the automation document.

TODO: EXAMPLE