awsssmincidents

package
v2.57.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 27, 2022 License: Apache-2.0 Imports: 7 Imported by: 0

README

AWS::SSMIncidents Construct Library

This module is part of the AWS Cloud Development Kit project.

import ssmincidents "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::SSMIncidents.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

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.

func CfnReplicationSet_IsCfnResource 

func CfnReplicationSet_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnReplicationSet_IsConstruct 

func CfnReplicationSet_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

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.

func CfnResponsePlan_IsCfnResource 

func CfnResponsePlan_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnResponsePlan_IsConstruct 

func CfnResponsePlan_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func NewCfnReplicationSet_Override 

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

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

func NewCfnResponsePlan_Override 

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

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

Types

type CfnReplicationSet 

type CfnReplicationSet interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	// 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{}
	SetDeletionProtected(val interface{})
	// The logical ID for this CloudFormation stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The tree node.
	Node() constructs.Node
	// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// Specifies the Regions of the replication set.
	Regions() interface{}
	SetRegions(val interface{})
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	// `AWS::SSMIncidents::ReplicationSet.Tags`.
	Tags() awscdk.TagManager
	// Deprecated.
	// Deprecated: use `updatedProperties`
	//
	// Return properties modified after initiation
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperties() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependency(target awscdk.CfnResource)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	// Deprecated: use addDependency.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// To include a literal `.` in the property name, prefix with a `\`. In most
	// programming languages you will need to write this as `"\\."` because the
	// `\` itself will need to be escaped.
	//
	// For example,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`
	//
	// The `value` argument to `addOverride` will not be processed or translated
	// in any way. Pass raw JSON values in here with the correct capitalization
	// for CloudFormation. If you pass CDK classes or structs, they will be
	// rendered with lowercased key names, and CloudFormation will reject the
	// template.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// The Removal Policy controls what happens to this resource when it stops
	// being managed by CloudFormation, either because you've removed it from the
	// CDK application or because you've made a change that requires the resource
	// to be replaced.
	//
	// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
	// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
	// cases, a snapshot can be taken of the resource prior to deletion
	// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
	// can be found in the following link:.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
	//
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Retrieves an array of resources this resource depends on.
	//
	// This assembles dependencies on resources across stacks (including nested stacks)
	// automatically.
	ObtainDependencies() *[]interface{}
	// Get a shallow copy of dependencies between this resource and other resources in the same stack.
	ObtainResourceDependencies() *[]awscdk.CfnResource
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Indicates that this resource no longer depends on another resource.
	//
	// This can be used for resources across stacks (including nested stacks)
	// and the dependency will automatically be removed from the relevant scope.
	RemoveDependency(target awscdk.CfnResource)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Replaces one dependency with another.
	ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	ShouldSynthesize() *bool
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *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.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnReplicationSet := awscdk.Aws_ssmincidents.NewCfnReplicationSet(this, jsii.String("MyCfnReplicationSet"), &cfnReplicationSetProps{
	regions: []interface{}{
		&replicationRegionProperty{
			regionConfiguration: &regionConfigurationProperty{
				sseKmsKeyId: jsii.String("sseKmsKeyId"),
			},
			regionName: jsii.String("regionName"),
		},
	},

	// the properties below are optional
	deletionProtected: jsii.Boolean(false),
	tags: []cfnTag{
		&cfnTag{
			key: jsii.String("key"),
			value: jsii.String("value"),
		},
	},
})

func NewCfnReplicationSet 

func NewCfnReplicationSet(scope constructs.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{} `field:"required" 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{} `field:"optional" json:"deletionProtected" yaml:"deletionProtected"`
	// `AWS::SSMIncidents::ReplicationSet.Tags`.
	Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}

Properties for defining a `CfnReplicationSet`.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnReplicationSetProps := &cfnReplicationSetProps{
	regions: []interface{}{
		&replicationRegionProperty{
			regionConfiguration: &regionConfigurationProperty{
				sseKmsKeyId: jsii.String("sseKmsKeyId"),
			},
			regionName: jsii.String("regionName"),
		},
	},

	// the properties below are optional
	deletionProtected: jsii.Boolean(false),
	tags: []cfnTag{
		&cfnTag{
			key: jsii.String("key"),
			value: jsii.String("value"),
		},
	},
}

type CfnReplicationSet_RegionConfigurationProperty 

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

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

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

regionConfigurationProperty := &regionConfigurationProperty{
	sseKmsKeyId: jsii.String("sseKmsKeyId"),
}

type CfnReplicationSet_ReplicationRegionProperty 

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

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

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

replicationRegionProperty := &replicationRegionProperty{
	regionConfiguration: &regionConfigurationProperty{
		sseKmsKeyId: jsii.String("sseKmsKeyId"),
	},
	regionName: jsii.String("regionName"),
}

type CfnResponsePlan 

type CfnResponsePlan interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The actions that the response plan starts at the beginning of an incident.
	Actions() interface{}
	SetActions(val interface{})
	AttrArn() *string
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// The AWS Chatbot chat channel used for collaboration during an incident.
	ChatChannel() interface{}
	SetChatChannel(val interface{})
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	// The human readable name of the response plan.
	DisplayName() *string
	SetDisplayName(val *string)
	// The contacts and escalation plans that the response plan engages during an incident.
	Engagements() *[]*string
	SetEngagements(val *[]*string)
	// Details used to create an incident when using this response plan.
	IncidentTemplate() interface{}
	SetIncidentTemplate(val interface{})
	// `AWS::SSMIncidents::ResponsePlan.Integrations`.
	Integrations() interface{}
	SetIntegrations(val interface{})
	// The logical ID for this CloudFormation stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The name of the response plan.
	Name() *string
	SetName(val *string)
	// The tree node.
	Node() constructs.Node
	// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	// 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.TagManager
	// Deprecated.
	// Deprecated: use `updatedProperties`
	//
	// Return properties modified after initiation
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperties() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependency(target awscdk.CfnResource)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	// Deprecated: use addDependency.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// To include a literal `.` in the property name, prefix with a `\`. In most
	// programming languages you will need to write this as `"\\."` because the
	// `\` itself will need to be escaped.
	//
	// For example,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`
	//
	// The `value` argument to `addOverride` will not be processed or translated
	// in any way. Pass raw JSON values in here with the correct capitalization
	// for CloudFormation. If you pass CDK classes or structs, they will be
	// rendered with lowercased key names, and CloudFormation will reject the
	// template.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// The Removal Policy controls what happens to this resource when it stops
	// being managed by CloudFormation, either because you've removed it from the
	// CDK application or because you've made a change that requires the resource
	// to be replaced.
	//
	// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
	// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
	// cases, a snapshot can be taken of the resource prior to deletion
	// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
	// can be found in the following link:.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
	//
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Retrieves an array of resources this resource depends on.
	//
	// This assembles dependencies on resources across stacks (including nested stacks)
	// automatically.
	ObtainDependencies() *[]interface{}
	// Get a shallow copy of dependencies between this resource and other resources in the same stack.
	ObtainResourceDependencies() *[]awscdk.CfnResource
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Indicates that this resource no longer depends on another resource.
	//
	// This can be used for resources across stacks (including nested stacks)
	// and the dependency will automatically be removed from the relevant scope.
	RemoveDependency(target awscdk.CfnResource)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Replaces one dependency with another.
	ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	ShouldSynthesize() *bool
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *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.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnResponsePlan := awscdk.Aws_ssmincidents.NewCfnResponsePlan(this, jsii.String("MyCfnResponsePlan"), &cfnResponsePlanProps{
	incidentTemplate: &incidentTemplateProperty{
		impact: jsii.Number(123),
		title: jsii.String("title"),

		// the properties below are optional
		dedupeString: jsii.String("dedupeString"),
		incidentTags: []interface{}{
			&cfnTag{
				key: jsii.String("key"),
				value: jsii.String("value"),
			},
		},
		notificationTargets: []interface{}{
			&notificationTargetItemProperty{
				snsTopicArn: jsii.String("snsTopicArn"),
			},
		},
		summary: jsii.String("summary"),
	},
	name: jsii.String("name"),

	// the properties below are optional
	actions: []interface{}{
		&actionProperty{
			ssmAutomation: &ssmAutomationProperty{
				documentName: jsii.String("documentName"),
				roleArn: jsii.String("roleArn"),

				// the properties below are optional
				documentVersion: jsii.String("documentVersion"),
				dynamicParameters: []interface{}{
					&dynamicSsmParameterProperty{
						key: jsii.String("key"),
						value: &dynamicSsmParameterValueProperty{
							variable: jsii.String("variable"),
						},
					},
				},
				parameters: []interface{}{
					&ssmParameterProperty{
						key: jsii.String("key"),
						values: []*string{
							jsii.String("values"),
						},
					},
				},
				targetAccount: jsii.String("targetAccount"),
			},
		},
	},
	chatChannel: &chatChannelProperty{
		chatbotSns: []*string{
			jsii.String("chatbotSns"),
		},
	},
	displayName: jsii.String("displayName"),
	engagements: []*string{
		jsii.String("engagements"),
	},
	integrations: []interface{}{
		&integrationProperty{
			pagerDutyConfiguration: &pagerDutyConfigurationProperty{
				name: jsii.String("name"),
				pagerDutyIncidentConfiguration: &pagerDutyIncidentConfigurationProperty{
					serviceId: jsii.String("serviceId"),
				},
				secretId: jsii.String("secretId"),
			},
		},
	},
	tags: []*cfnTag{
		&cfnTag{
			key: jsii.String("key"),
			value: jsii.String("value"),
		},
	},
})

func NewCfnResponsePlan 

func NewCfnResponsePlan(scope constructs.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{} `field:"required" json:"incidentTemplate" yaml:"incidentTemplate"`
	// The name of the response plan.
	Name *string `field:"required" json:"name" yaml:"name"`
	// The actions that the response plan starts at the beginning of an incident.
	Actions interface{} `field:"optional" json:"actions" yaml:"actions"`
	// The AWS Chatbot chat channel used for collaboration during an incident.
	ChatChannel interface{} `field:"optional" json:"chatChannel" yaml:"chatChannel"`
	// The human readable name of the response plan.
	DisplayName *string `field:"optional" json:"displayName" yaml:"displayName"`
	// The contacts and escalation plans that the response plan engages during an incident.
	Engagements *[]*string `field:"optional" json:"engagements" yaml:"engagements"`
	// `AWS::SSMIncidents::ResponsePlan.Integrations`.
	Integrations interface{} `field:"optional" json:"integrations" yaml:"integrations"`
	// 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 `field:"optional" json:"tags" yaml:"tags"`
}

Properties for defining a `CfnResponsePlan`.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnResponsePlanProps := &cfnResponsePlanProps{
	incidentTemplate: &incidentTemplateProperty{
		impact: jsii.Number(123),
		title: jsii.String("title"),

		// the properties below are optional
		dedupeString: jsii.String("dedupeString"),
		incidentTags: []interface{}{
			&cfnTag{
				key: jsii.String("key"),
				value: jsii.String("value"),
			},
		},
		notificationTargets: []interface{}{
			&notificationTargetItemProperty{
				snsTopicArn: jsii.String("snsTopicArn"),
			},
		},
		summary: jsii.String("summary"),
	},
	name: jsii.String("name"),

	// the properties below are optional
	actions: []interface{}{
		&actionProperty{
			ssmAutomation: &ssmAutomationProperty{
				documentName: jsii.String("documentName"),
				roleArn: jsii.String("roleArn"),

				// the properties below are optional
				documentVersion: jsii.String("documentVersion"),
				dynamicParameters: []interface{}{
					&dynamicSsmParameterProperty{
						key: jsii.String("key"),
						value: &dynamicSsmParameterValueProperty{
							variable: jsii.String("variable"),
						},
					},
				},
				parameters: []interface{}{
					&ssmParameterProperty{
						key: jsii.String("key"),
						values: []*string{
							jsii.String("values"),
						},
					},
				},
				targetAccount: jsii.String("targetAccount"),
			},
		},
	},
	chatChannel: &chatChannelProperty{
		chatbotSns: []*string{
			jsii.String("chatbotSns"),
		},
	},
	displayName: jsii.String("displayName"),
	engagements: []*string{
		jsii.String("engagements"),
	},
	integrations: []interface{}{
		&integrationProperty{
			pagerDutyConfiguration: &pagerDutyConfigurationProperty{
				name: jsii.String("name"),
				pagerDutyIncidentConfiguration: &pagerDutyIncidentConfigurationProperty{
					serviceId: jsii.String("serviceId"),
				},
				secretId: jsii.String("secretId"),
			},
		},
	},
	tags: []*cfnTag{
		&cfnTag{
			key: jsii.String("key"),
			value: jsii.String("value"),
		},
	},
}

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{} `field:"optional" json:"ssmAutomation" yaml:"ssmAutomation"`
}

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

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

actionProperty := &actionProperty{
	ssmAutomation: &ssmAutomationProperty{
		documentName: jsii.String("documentName"),
		roleArn: jsii.String("roleArn"),

		// the properties below are optional
		documentVersion: jsii.String("documentVersion"),
		dynamicParameters: []interface{}{
			&dynamicSsmParameterProperty{
				key: jsii.String("key"),
				value: &dynamicSsmParameterValueProperty{
					variable: jsii.String("variable"),
				},
			},
		},
		parameters: []interface{}{
			&ssmParameterProperty{
				key: jsii.String("key"),
				values: []*string{
					jsii.String("values"),
				},
			},
		},
		targetAccount: jsii.String("targetAccount"),
	},
}

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 `field:"optional" json:"chatbotSns" yaml:"chatbotSns"`
}

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

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

chatChannelProperty := &chatChannelProperty{
	chatbotSns: []*string{
		jsii.String("chatbotSns"),
	},
}

type CfnResponsePlan_DynamicSsmParameterProperty added in v2.27.0 

type CfnResponsePlan_DynamicSsmParameterProperty struct {
	// `CfnResponsePlan.DynamicSsmParameterProperty.Key`.
	Key *string `field:"required" json:"key" yaml:"key"`
	// `CfnResponsePlan.DynamicSsmParameterProperty.Value`.
	Value interface{} `field:"required" json:"value" yaml:"value"`
}

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

dynamicSsmParameterProperty := &dynamicSsmParameterProperty{
	key: jsii.String("key"),
	value: &dynamicSsmParameterValueProperty{
		variable: jsii.String("variable"),
	},
}

type CfnResponsePlan_DynamicSsmParameterValueProperty added in v2.27.0 

type CfnResponsePlan_DynamicSsmParameterValueProperty struct {
	// `CfnResponsePlan.DynamicSsmParameterValueProperty.Variable`.
	Variable *string `field:"optional" json:"variable" yaml:"variable"`
}

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

dynamicSsmParameterValueProperty := &dynamicSsmParameterValueProperty{
	variable: jsii.String("variable"),
}

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 `field:"required" json:"impact" yaml:"impact"`
	// The title of the incident is a brief and easily recognizable.
	Title *string `field:"required" json:"title" yaml:"title"`
	// Used to create only one incident record for an incident.
	DedupeString *string `field:"optional" json:"dedupeString" yaml:"dedupeString"`
	// `CfnResponsePlan.IncidentTemplateProperty.IncidentTags`.
	IncidentTags interface{} `field:"optional" json:"incidentTags" yaml:"incidentTags"`
	// 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{} `field:"optional" json:"notificationTargets" yaml:"notificationTargets"`
	// The summary describes what has happened during the incident.
	Summary *string `field:"optional" json:"summary" yaml:"summary"`
}

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

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

incidentTemplateProperty := &incidentTemplateProperty{
	impact: jsii.Number(123),
	title: jsii.String("title"),

	// the properties below are optional
	dedupeString: jsii.String("dedupeString"),
	incidentTags: []interface{}{
		&cfnTag{
			key: jsii.String("key"),
			value: jsii.String("value"),
		},
	},
	notificationTargets: []interface{}{
		&notificationTargetItemProperty{
			snsTopicArn: jsii.String("snsTopicArn"),
		},
	},
	summary: jsii.String("summary"),
}

type CfnResponsePlan_IntegrationProperty added in v2.55.0 

type CfnResponsePlan_IntegrationProperty struct {
	// `CfnResponsePlan.IntegrationProperty.PagerDutyConfiguration`.
	PagerDutyConfiguration interface{} `field:"required" json:"pagerDutyConfiguration" yaml:"pagerDutyConfiguration"`
}

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

integrationProperty := &integrationProperty{
	pagerDutyConfiguration: &pagerDutyConfigurationProperty{
		name: jsii.String("name"),
		pagerDutyIncidentConfiguration: &pagerDutyIncidentConfigurationProperty{
			serviceId: jsii.String("serviceId"),
		},
		secretId: jsii.String("secretId"),
	},
}

type CfnResponsePlan_NotificationTargetItemProperty 

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

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

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

notificationTargetItemProperty := &notificationTargetItemProperty{
	snsTopicArn: jsii.String("snsTopicArn"),
}

type CfnResponsePlan_PagerDutyConfigurationProperty added in v2.55.0 

type CfnResponsePlan_PagerDutyConfigurationProperty struct {
	// `CfnResponsePlan.PagerDutyConfigurationProperty.Name`.
	Name *string `field:"required" json:"name" yaml:"name"`
	// `CfnResponsePlan.PagerDutyConfigurationProperty.PagerDutyIncidentConfiguration`.
	PagerDutyIncidentConfiguration interface{} `field:"required" json:"pagerDutyIncidentConfiguration" yaml:"pagerDutyIncidentConfiguration"`
	// `CfnResponsePlan.PagerDutyConfigurationProperty.SecretId`.
	SecretId *string `field:"required" json:"secretId" yaml:"secretId"`
}

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

pagerDutyConfigurationProperty := &pagerDutyConfigurationProperty{
	name: jsii.String("name"),
	pagerDutyIncidentConfiguration: &pagerDutyIncidentConfigurationProperty{
		serviceId: jsii.String("serviceId"),
	},
	secretId: jsii.String("secretId"),
}

type CfnResponsePlan_PagerDutyIncidentConfigurationProperty added in v2.55.0 

type CfnResponsePlan_PagerDutyIncidentConfigurationProperty struct {
	// `CfnResponsePlan.PagerDutyIncidentConfigurationProperty.ServiceId`.
	ServiceId *string `field:"required" json:"serviceId" yaml:"serviceId"`
}

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

pagerDutyIncidentConfigurationProperty := &pagerDutyIncidentConfigurationProperty{
	serviceId: jsii.String("serviceId"),
}

type CfnResponsePlan_SsmAutomationProperty 

type CfnResponsePlan_SsmAutomationProperty struct {
	// The automation document's name.
	DocumentName *string `field:"required" json:"documentName" yaml:"documentName"`
	// The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
	RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"`
	// The automation document's version to use when running.
	DocumentVersion *string `field:"optional" json:"documentVersion" yaml:"documentVersion"`
	// `CfnResponsePlan.SsmAutomationProperty.DynamicParameters`.
	DynamicParameters interface{} `field:"optional" json:"dynamicParameters" yaml:"dynamicParameters"`
	// The key-value pair parameters to use when running the automation document.
	Parameters interface{} `field:"optional" 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 `field:"optional" 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.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

ssmAutomationProperty := &ssmAutomationProperty{
	documentName: jsii.String("documentName"),
	roleArn: jsii.String("roleArn"),

	// the properties below are optional
	documentVersion: jsii.String("documentVersion"),
	dynamicParameters: []interface{}{
		&dynamicSsmParameterProperty{
			key: jsii.String("key"),
			value: &dynamicSsmParameterValueProperty{
				variable: jsii.String("variable"),
			},
		},
	},
	parameters: []interface{}{
		&ssmParameterProperty{
			key: jsii.String("key"),
			values: []*string{
				jsii.String("values"),
			},
		},
	},
	targetAccount: jsii.String("targetAccount"),
}

type CfnResponsePlan_SsmParameterProperty 

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

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

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

ssmParameterProperty := &ssmParameterProperty{
	key: jsii.String("key"),
	values: []*string{
		jsii.String("values"),
	},
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.