awsssmcontacts

package
v1.204.0-devpreview Latest Latest
Warning

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

 Go to latest Published: Jun 19, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

README

AWS::SSMContacts Construct Library

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

import ssmcontacts "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::SSMContacts.

(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 CfnContactChannel_CFN_RESOURCE_TYPE_NAME 

func CfnContactChannel_CFN_RESOURCE_TYPE_NAME() *string

func CfnContactChannel_IsCfnElement 

func CfnContactChannel_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 CfnContactChannel_IsCfnResource 

func CfnContactChannel_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnContactChannel_IsConstruct 

func CfnContactChannel_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnContact_CFN_RESOURCE_TYPE_NAME 

func CfnContact_CFN_RESOURCE_TYPE_NAME() *string

func CfnContact_IsCfnElement 

func CfnContact_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 CfnContact_IsCfnResource 

func CfnContact_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnContact_IsConstruct 

func CfnContact_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnPlan_CFN_RESOURCE_TYPE_NAME 

func CfnPlan_CFN_RESOURCE_TYPE_NAME() *string

func CfnPlan_IsCfnElement 

func CfnPlan_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 CfnPlan_IsCfnResource 

func CfnPlan_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnPlan_IsConstruct 

func CfnPlan_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnRotation_CFN_RESOURCE_TYPE_NAME 

func CfnRotation_CFN_RESOURCE_TYPE_NAME() *string

func CfnRotation_IsCfnElement 

func CfnRotation_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 CfnRotation_IsCfnResource 

func CfnRotation_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnRotation_IsConstruct 

func CfnRotation_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func NewCfnContactChannel_Override 

func NewCfnContactChannel_Override(c CfnContactChannel, scope awscdk.Construct, id *string, props *CfnContactChannelProps)

Create a new `AWS::SSMContacts::ContactChannel`.

func NewCfnContact_Override 

func NewCfnContact_Override(c CfnContact, scope awscdk.Construct, id *string, props *CfnContactProps)

Create a new `AWS::SSMContacts::Contact`.

func NewCfnPlan_Override 

func NewCfnPlan_Override(c CfnPlan, scope awscdk.Construct, id *string, props *CfnPlanProps)

Create a new `AWS::SSMContacts::Plan`.

func NewCfnRotation_Override 

func NewCfnRotation_Override(c CfnRotation, scope awscdk.Construct, id *string, props *CfnRotationProps)

Create a new `AWS::SSMContacts::Rotation`.

Types

type CfnContact 

type CfnContact interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The unique and identifiable alias of the contact or escalation plan.
	Alias() *string
	SetAlias(val *string)
	// The Amazon Resource Name (ARN) of the `Contact` resource, such as `arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias` .
	AttrArn() *string
	// Options for this resource, such as condition, update policy etc.
	// Experimental.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	// Experimental.
	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.
	// Experimental.
	CreationStack() *[]*string
	// The full name of the contact or escalation plan.
	DisplayName() *string
	SetDisplayName(val *string)
	// 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.
	// Experimental.
	LogicalId() *string
	// The construct tree node associated with this construct.
	// Experimental.
	Node() awscdk.ConstructNode
	// A list of stages.
	//
	// A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.
	Plan() interface{}
	SetPlan(val interface{})
	// 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 })`.
	// Experimental.
	Ref() *string
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	// Experimental.
	Stack() awscdk.Stack
	// Refers to the type of contact:.
	//
	// - `PERSONAL` : A single, individual contact.
	// - `ESCALATION` : An escalation plan.
	// - `ONCALL_SCHEDULE` : An on-call schedule.
	Type() *string
	SetType(val *string)
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	// Experimental.
	UpdatedProperites() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	// Experimental.
	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.
	// Experimental.
	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.
	//
	// Experimental.
	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.
	// Experimental.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	// Experimental.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	// Experimental.
	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`).
	// Experimental.
	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.
	// Experimental.
	GetAtt(attributeName *string) 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.
	//
	// Experimental.
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	// Experimental.
	ShouldSynthesize() *bool
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	Synthesize(session awscdk.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	// Experimental.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	Validate() *[]*string
	// Experimental.
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SSMContacts::Contact`.

The `AWS::SSMContacts::Contact` resource specifies a contact or escalation plan. Incident Manager contacts are a subset of actions and data types that you can use for managing responder engagement and interaction.

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"

cfnContact := awscdk.Aws_ssmcontacts.NewCfnContact(this, jsii.String("MyCfnContact"), &CfnContactProps{
	Alias: jsii.String("alias"),
	DisplayName: jsii.String("displayName"),
	Type: jsii.String("type"),

	// the properties below are optional
	Plan: []interface{}{
		&StageProperty{
			DurationInMinutes: jsii.Number(123),
			RotationIds: []*string{
				jsii.String("rotationIds"),
			},
			Targets: []interface{}{
				&TargetsProperty{
					ChannelTargetInfo: &ChannelTargetInfoProperty{
						ChannelId: jsii.String("channelId"),
						RetryIntervalInMinutes: jsii.Number(123),
					},
					ContactTargetInfo: &ContactTargetInfoProperty{
						ContactId: jsii.String("contactId"),
						IsEssential: jsii.Boolean(false),
					},
				},
			},
		},
	},
})

func NewCfnContact 

func NewCfnContact(scope awscdk.Construct, id *string, props *CfnContactProps) CfnContact

Create a new `AWS::SSMContacts::Contact`.

type CfnContactChannel 

type CfnContactChannel interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The Amazon Resource Name (ARN) of the `ContactChannel` resource.
	AttrArn() *string
	// Options for this resource, such as condition, update policy etc.
	// Experimental.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	// Experimental.
	CfnResourceType() *string
	// The details that Incident Manager uses when trying to engage the contact channel.
	ChannelAddress() *string
	SetChannelAddress(val *string)
	// The name of the contact channel.
	ChannelName() *string
	SetChannelName(val *string)
	// The type of the contact channel. Incident Manager supports three contact methods:.
	//
	// - SMS
	// - VOICE
	// - EMAIL.
	ChannelType() *string
	SetChannelType(val *string)
	// The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.
	ContactId() *string
	SetContactId(val *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.
	// Experimental.
	CreationStack() *[]*string
	// If you want to activate the channel at a later time, you can choose to defer activation.
	//
	// Incident Manager can't engage your contact channel until it has been activated.
	DeferActivation() interface{}
	SetDeferActivation(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.
	// Experimental.
	LogicalId() *string
	// The construct tree node associated with this construct.
	// Experimental.
	Node() awscdk.ConstructNode
	// 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 })`.
	// Experimental.
	Ref() *string
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	// Experimental.
	Stack() awscdk.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	// Experimental.
	UpdatedProperites() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	// Experimental.
	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.
	// Experimental.
	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.
	//
	// Experimental.
	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.
	// Experimental.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	// Experimental.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	// Experimental.
	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`).
	// Experimental.
	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.
	// Experimental.
	GetAtt(attributeName *string) 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.
	//
	// Experimental.
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	// Experimental.
	ShouldSynthesize() *bool
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	Synthesize(session awscdk.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	// Experimental.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	Validate() *[]*string
	// Experimental.
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SSMContacts::ContactChannel`.

The `AWS::SSMContacts::ContactChannel` resource specifies a contact channel as the method that Incident Manager uses to engage your contact.

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"

cfnContactChannel := awscdk.Aws_ssmcontacts.NewCfnContactChannel(this, jsii.String("MyCfnContactChannel"), &CfnContactChannelProps{
	ChannelAddress: jsii.String("channelAddress"),
	ChannelName: jsii.String("channelName"),
	ChannelType: jsii.String("channelType"),
	ContactId: jsii.String("contactId"),

	// the properties below are optional
	DeferActivation: jsii.Boolean(false),
})

func NewCfnContactChannel 

func NewCfnContactChannel(scope awscdk.Construct, id *string, props *CfnContactChannelProps) CfnContactChannel

Create a new `AWS::SSMContacts::ContactChannel`.

type CfnContactChannelProps 

type CfnContactChannelProps struct {
	// The details that Incident Manager uses when trying to engage the contact channel.
	ChannelAddress *string `field:"required" json:"channelAddress" yaml:"channelAddress"`
	// The name of the contact channel.
	ChannelName *string `field:"required" json:"channelName" yaml:"channelName"`
	// The type of the contact channel. Incident Manager supports three contact methods:.
	//
	// - SMS
	// - VOICE
	// - EMAIL.
	ChannelType *string `field:"required" json:"channelType" yaml:"channelType"`
	// The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.
	ContactId *string `field:"required" json:"contactId" yaml:"contactId"`
	// If you want to activate the channel at a later time, you can choose to defer activation.
	//
	// Incident Manager can't engage your contact channel until it has been activated.
	DeferActivation interface{} `field:"optional" json:"deferActivation" yaml:"deferActivation"`
}

Properties for defining a `CfnContactChannel`.

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"

cfnContactChannelProps := &CfnContactChannelProps{
	ChannelAddress: jsii.String("channelAddress"),
	ChannelName: jsii.String("channelName"),
	ChannelType: jsii.String("channelType"),
	ContactId: jsii.String("contactId"),

	// the properties below are optional
	DeferActivation: jsii.Boolean(false),
}

type CfnContactProps 

type CfnContactProps struct {
	// The unique and identifiable alias of the contact or escalation plan.
	Alias *string `field:"required" json:"alias" yaml:"alias"`
	// The full name of the contact or escalation plan.
	DisplayName *string `field:"required" json:"displayName" yaml:"displayName"`
	// Refers to the type of contact:.
	//
	// - `PERSONAL` : A single, individual contact.
	// - `ESCALATION` : An escalation plan.
	// - `ONCALL_SCHEDULE` : An on-call schedule.
	Type *string `field:"required" json:"type" yaml:"type"`
	// A list of stages.
	//
	// A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.
	Plan interface{} `field:"optional" json:"plan" yaml:"plan"`
}

Properties for defining a `CfnContact`.

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"

cfnContactProps := &CfnContactProps{
	Alias: jsii.String("alias"),
	DisplayName: jsii.String("displayName"),
	Type: jsii.String("type"),

	// the properties below are optional
	Plan: []interface{}{
		&StageProperty{
			DurationInMinutes: jsii.Number(123),
			RotationIds: []*string{
				jsii.String("rotationIds"),
			},
			Targets: []interface{}{
				&TargetsProperty{
					ChannelTargetInfo: &ChannelTargetInfoProperty{
						ChannelId: jsii.String("channelId"),
						RetryIntervalInMinutes: jsii.Number(123),
					},
					ContactTargetInfo: &ContactTargetInfoProperty{
						ContactId: jsii.String("contactId"),
						IsEssential: jsii.Boolean(false),
					},
				},
			},
		},
	},
}

type CfnContact_ChannelTargetInfoProperty 

type CfnContact_ChannelTargetInfoProperty struct {
	// The Amazon Resource Name (ARN) of the contact channel.
	ChannelId *string `field:"required" json:"channelId" yaml:"channelId"`
	// The number of minutes to wait before retrying to send engagement if the engagement initially failed.
	RetryIntervalInMinutes *float64 `field:"required" json:"retryIntervalInMinutes" yaml:"retryIntervalInMinutes"`
}

Information about the contact channel that Incident Manager uses to engage the contact.

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"

channelTargetInfoProperty := &ChannelTargetInfoProperty{
	ChannelId: jsii.String("channelId"),
	RetryIntervalInMinutes: jsii.Number(123),
}

type CfnContact_ContactTargetInfoProperty 

type CfnContact_ContactTargetInfoProperty struct {
	// The Amazon Resource Name (ARN) of the contact.
	ContactId *string `field:"required" json:"contactId" yaml:"contactId"`
	// A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.
	IsEssential interface{} `field:"required" json:"isEssential" yaml:"isEssential"`
}

The contact that Incident Manager is engaging 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"

contactTargetInfoProperty := &ContactTargetInfoProperty{
	ContactId: jsii.String("contactId"),
	IsEssential: jsii.Boolean(false),
}

type CfnContact_StageProperty 

type CfnContact_StageProperty struct {
	// The time to wait until beginning the next stage.
	//
	// The duration can only be set to 0 if a target is specified.
	DurationInMinutes *float64 `field:"optional" json:"durationInMinutes" yaml:"durationInMinutes"`
	// The Amazon Resource Names (ARNs) of the on-call rotations associated with the plan.
	RotationIds *[]*string `field:"optional" json:"rotationIds" yaml:"rotationIds"`
	// The contacts or contact methods that the escalation plan or engagement plan is engaging.
	Targets interface{} `field:"optional" json:"targets" yaml:"targets"`
}

The `Stage` property type specifies a set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.

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"

stageProperty := &StageProperty{
	DurationInMinutes: jsii.Number(123),
	RotationIds: []*string{
		jsii.String("rotationIds"),
	},
	Targets: []interface{}{
		&TargetsProperty{
			ChannelTargetInfo: &ChannelTargetInfoProperty{
				ChannelId: jsii.String("channelId"),
				RetryIntervalInMinutes: jsii.Number(123),
			},
			ContactTargetInfo: &ContactTargetInfoProperty{
				ContactId: jsii.String("contactId"),
				IsEssential: jsii.Boolean(false),
			},
		},
	},
}

type CfnContact_TargetsProperty 

type CfnContact_TargetsProperty struct {
	// Information about the contact channel that Incident Manager engages.
	ChannelTargetInfo interface{} `field:"optional" json:"channelTargetInfo" yaml:"channelTargetInfo"`
	// The contact that Incident Manager is engaging during an incident.
	ContactTargetInfo interface{} `field:"optional" json:"contactTargetInfo" yaml:"contactTargetInfo"`
}

The contact or contact channel that's being engaged.

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"

targetsProperty := &TargetsProperty{
	ChannelTargetInfo: &ChannelTargetInfoProperty{
		ChannelId: jsii.String("channelId"),
		RetryIntervalInMinutes: jsii.Number(123),
	},
	ContactTargetInfo: &ContactTargetInfoProperty{
		ContactId: jsii.String("contactId"),
		IsEssential: jsii.Boolean(false),
	},
}

type CfnPlan 

type CfnPlan interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The Amazon Resource Name (ARN) of the `Plan` resource.
	AttrArn() *string
	// Options for this resource, such as condition, update policy etc.
	// Experimental.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	// Experimental.
	CfnResourceType() *string
	// The Amazon Resource Name (ARN) of the contact.
	ContactId() *string
	SetContactId(val *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.
	// Experimental.
	CreationStack() *[]*string
	// 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.
	// Experimental.
	LogicalId() *string
	// The construct tree node associated with this construct.
	// Experimental.
	Node() awscdk.ConstructNode
	// 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 })`.
	// Experimental.
	Ref() *string
	// The Amazon Resource Names (ARNs) of the on-call rotations associated with the plan.
	RotationIds() *[]*string
	SetRotationIds(val *[]*string)
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	// Experimental.
	Stack() awscdk.Stack
	// A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.
	Stages() interface{}
	SetStages(val 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.
	// Experimental.
	UpdatedProperites() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	// Experimental.
	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.
	// Experimental.
	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.
	//
	// Experimental.
	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.
	// Experimental.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	// Experimental.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	// Experimental.
	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`).
	// Experimental.
	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.
	// Experimental.
	GetAtt(attributeName *string) 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.
	//
	// Experimental.
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	// Experimental.
	ShouldSynthesize() *bool
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	Synthesize(session awscdk.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	// Experimental.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	Validate() *[]*string
	// Experimental.
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SSMContacts::Plan`.

Information about the stages and on-call rotation teams associated with an escalation plan or engagement 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"

cfnPlan := awscdk.Aws_ssmcontacts.NewCfnPlan(this, jsii.String("MyCfnPlan"), &CfnPlanProps{
	ContactId: jsii.String("contactId"),

	// the properties below are optional
	RotationIds: []*string{
		jsii.String("rotationIds"),
	},
	Stages: []interface{}{
		&StageProperty{
			DurationInMinutes: jsii.Number(123),

			// the properties below are optional
			Targets: []interface{}{
				&TargetsProperty{
					ChannelTargetInfo: &ChannelTargetInfoProperty{
						ChannelId: jsii.String("channelId"),
						RetryIntervalInMinutes: jsii.Number(123),
					},
					ContactTargetInfo: &ContactTargetInfoProperty{
						ContactId: jsii.String("contactId"),
						IsEssential: jsii.Boolean(false),
					},
				},
			},
		},
	},
})

func NewCfnPlan 

func NewCfnPlan(scope awscdk.Construct, id *string, props *CfnPlanProps) CfnPlan

Create a new `AWS::SSMContacts::Plan`.

type CfnPlanProps 

type CfnPlanProps struct {
	// The Amazon Resource Name (ARN) of the contact.
	ContactId *string `field:"required" json:"contactId" yaml:"contactId"`
	// The Amazon Resource Names (ARNs) of the on-call rotations associated with the plan.
	RotationIds *[]*string `field:"optional" json:"rotationIds" yaml:"rotationIds"`
	// A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.
	Stages interface{} `field:"optional" json:"stages" yaml:"stages"`
}

Properties for defining a `CfnPlan`.

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"

cfnPlanProps := &CfnPlanProps{
	ContactId: jsii.String("contactId"),

	// the properties below are optional
	RotationIds: []*string{
		jsii.String("rotationIds"),
	},
	Stages: []interface{}{
		&StageProperty{
			DurationInMinutes: jsii.Number(123),

			// the properties below are optional
			Targets: []interface{}{
				&TargetsProperty{
					ChannelTargetInfo: &ChannelTargetInfoProperty{
						ChannelId: jsii.String("channelId"),
						RetryIntervalInMinutes: jsii.Number(123),
					},
					ContactTargetInfo: &ContactTargetInfoProperty{
						ContactId: jsii.String("contactId"),
						IsEssential: jsii.Boolean(false),
					},
				},
			},
		},
	},
}

type CfnPlan_ChannelTargetInfoProperty 

type CfnPlan_ChannelTargetInfoProperty struct {
	// The Amazon Resource Name (ARN) of the contact channel.
	ChannelId *string `field:"required" json:"channelId" yaml:"channelId"`
	// The number of minutes to wait before retrying to send engagement if the engagement initially failed.
	RetryIntervalInMinutes *float64 `field:"required" json:"retryIntervalInMinutes" yaml:"retryIntervalInMinutes"`
}

Information about the contact channel that Incident Manager uses to engage the contact.

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"

channelTargetInfoProperty := &ChannelTargetInfoProperty{
	ChannelId: jsii.String("channelId"),
	RetryIntervalInMinutes: jsii.Number(123),
}

type CfnPlan_ContactTargetInfoProperty 

type CfnPlan_ContactTargetInfoProperty struct {
	// The Amazon Resource Name (ARN) of the contact.
	ContactId *string `field:"required" json:"contactId" yaml:"contactId"`
	// A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.
	IsEssential interface{} `field:"required" json:"isEssential" yaml:"isEssential"`
}

The contact that Incident Manager is engaging 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"

contactTargetInfoProperty := &ContactTargetInfoProperty{
	ContactId: jsii.String("contactId"),
	IsEssential: jsii.Boolean(false),
}

type CfnPlan_StageProperty 

type CfnPlan_StageProperty struct {
	// The time to wait until beginning the next stage.
	//
	// The duration can only be set to 0 if a target is specified.
	DurationInMinutes *float64 `field:"required" json:"durationInMinutes" yaml:"durationInMinutes"`
	// The contacts or contact methods that the escalation plan or engagement plan is engaging.
	Targets interface{} `field:"optional" json:"targets" yaml:"targets"`
}

A set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.

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"

stageProperty := &StageProperty{
	DurationInMinutes: jsii.Number(123),

	// the properties below are optional
	Targets: []interface{}{
		&TargetsProperty{
			ChannelTargetInfo: &ChannelTargetInfoProperty{
				ChannelId: jsii.String("channelId"),
				RetryIntervalInMinutes: jsii.Number(123),
			},
			ContactTargetInfo: &ContactTargetInfoProperty{
				ContactId: jsii.String("contactId"),
				IsEssential: jsii.Boolean(false),
			},
		},
	},
}

type CfnPlan_TargetsProperty 

type CfnPlan_TargetsProperty struct {
	// Information about the contact channel that Incident Manager engages.
	ChannelTargetInfo interface{} `field:"optional" json:"channelTargetInfo" yaml:"channelTargetInfo"`
	// Information about the contact that Incident Manager engages.
	ContactTargetInfo interface{} `field:"optional" json:"contactTargetInfo" yaml:"contactTargetInfo"`
}

The contact or contact channel that's being engaged.

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"

targetsProperty := &TargetsProperty{
	ChannelTargetInfo: &ChannelTargetInfoProperty{
		ChannelId: jsii.String("channelId"),
		RetryIntervalInMinutes: jsii.Number(123),
	},
	ContactTargetInfo: &ContactTargetInfoProperty{
		ContactId: jsii.String("contactId"),
		IsEssential: jsii.Boolean(false),
	},
}

type CfnRotation 

type CfnRotation interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The Amazon Resource Name (ARN) of the `Rotation` resource.
	AttrArn() *string
	// Options for this resource, such as condition, update policy etc.
	// Experimental.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	// Experimental.
	CfnResourceType() *string
	// The Amazon Resource Names (ARNs) of the contacts to add to the rotation.
	//
	// The order in which you list the contacts is their shift order in the rotation schedule.
	ContactIds() *[]*string
	SetContactIds(val *[]*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.
	// Experimental.
	CreationStack() *[]*string
	// 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.
	// Experimental.
	LogicalId() *string
	// The name for the rotation.
	Name() *string
	SetName(val *string)
	// The construct tree node associated with this construct.
	// Experimental.
	Node() awscdk.ConstructNode
	// Information about the rule that specifies when shift team members rotate.
	Recurrence() interface{}
	SetRecurrence(val interface{})
	// 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 })`.
	// Experimental.
	Ref() *string
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	// Experimental.
	Stack() awscdk.Stack
	// The date and time the rotation goes into effect.
	StartTime() *string
	SetStartTime(val *string)
	// Optional metadata to assign to the rotation.
	//
	// Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For more information, see [Tagging Incident Manager resources](https://docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html) in the *Incident Manager User Guide* .
	Tags() awscdk.TagManager
	// The time zone to base the rotation’s activity on, in Internet Assigned Numbers Authority (IANA) format.
	//
	// For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the [Time Zone Database](https://docs.aws.amazon.com/https://www.iana.org/time-zones) on the IANA website.
	TimeZoneId() *string
	SetTimeZoneId(val *string)
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	// Experimental.
	UpdatedProperites() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	// Experimental.
	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.
	// Experimental.
	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.
	//
	// Experimental.
	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.
	// Experimental.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	// Experimental.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	// Experimental.
	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`).
	// Experimental.
	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.
	// Experimental.
	GetAtt(attributeName *string) 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.
	//
	// Experimental.
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	// Experimental.
	ShouldSynthesize() *bool
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	Synthesize(session awscdk.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	// Experimental.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	Validate() *[]*string
	// Experimental.
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::SSMContacts::Rotation`.

Specifies a rotation in an on-call schedule.

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"

cfnRotation := awscdk.Aws_ssmcontacts.NewCfnRotation(this, jsii.String("MyCfnRotation"), &CfnRotationProps{
	ContactIds: []*string{
		jsii.String("contactIds"),
	},
	Name: jsii.String("name"),
	Recurrence: &RecurrenceSettingsProperty{
		NumberOfOnCalls: jsii.Number(123),
		RecurrenceMultiplier: jsii.Number(123),

		// the properties below are optional
		DailySettings: []*string{
			jsii.String("dailySettings"),
		},
		MonthlySettings: []interface{}{
			&MonthlySettingProperty{
				DayOfMonth: jsii.Number(123),
				HandOffTime: jsii.String("handOffTime"),
			},
		},
		ShiftCoverages: []interface{}{
			&ShiftCoverageProperty{
				CoverageTimes: []interface{}{
					&CoverageTimeProperty{
						EndTime: jsii.String("endTime"),
						StartTime: jsii.String("startTime"),
					},
				},
				DayOfWeek: jsii.String("dayOfWeek"),
			},
		},
		WeeklySettings: []interface{}{
			&WeeklySettingProperty{
				DayOfWeek: jsii.String("dayOfWeek"),
				HandOffTime: jsii.String("handOffTime"),
			},
		},
	},
	StartTime: jsii.String("startTime"),
	TimeZoneId: jsii.String("timeZoneId"),

	// the properties below are optional
	Tags: []cfnTag{
		&cfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
})

func NewCfnRotation 

func NewCfnRotation(scope awscdk.Construct, id *string, props *CfnRotationProps) CfnRotation

Create a new `AWS::SSMContacts::Rotation`.

type CfnRotationProps 

type CfnRotationProps struct {
	// The Amazon Resource Names (ARNs) of the contacts to add to the rotation.
	//
	// The order in which you list the contacts is their shift order in the rotation schedule.
	ContactIds *[]*string `field:"required" json:"contactIds" yaml:"contactIds"`
	// The name for the rotation.
	Name *string `field:"required" json:"name" yaml:"name"`
	// Information about the rule that specifies when shift team members rotate.
	Recurrence interface{} `field:"required" json:"recurrence" yaml:"recurrence"`
	// The date and time the rotation goes into effect.
	StartTime *string `field:"required" json:"startTime" yaml:"startTime"`
	// The time zone to base the rotation’s activity on, in Internet Assigned Numbers Authority (IANA) format.
	//
	// For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the [Time Zone Database](https://docs.aws.amazon.com/https://www.iana.org/time-zones) on the IANA website.
	TimeZoneId *string `field:"required" json:"timeZoneId" yaml:"timeZoneId"`
	// Optional metadata to assign to the rotation.
	//
	// Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For more information, see [Tagging Incident Manager resources](https://docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html) in the *Incident Manager User Guide* .
	Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}

Properties for defining a `CfnRotation`.

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"

cfnRotationProps := &CfnRotationProps{
	ContactIds: []*string{
		jsii.String("contactIds"),
	},
	Name: jsii.String("name"),
	Recurrence: &RecurrenceSettingsProperty{
		NumberOfOnCalls: jsii.Number(123),
		RecurrenceMultiplier: jsii.Number(123),

		// the properties below are optional
		DailySettings: []*string{
			jsii.String("dailySettings"),
		},
		MonthlySettings: []interface{}{
			&MonthlySettingProperty{
				DayOfMonth: jsii.Number(123),
				HandOffTime: jsii.String("handOffTime"),
			},
		},
		ShiftCoverages: []interface{}{
			&ShiftCoverageProperty{
				CoverageTimes: []interface{}{
					&CoverageTimeProperty{
						EndTime: jsii.String("endTime"),
						StartTime: jsii.String("startTime"),
					},
				},
				DayOfWeek: jsii.String("dayOfWeek"),
			},
		},
		WeeklySettings: []interface{}{
			&WeeklySettingProperty{
				DayOfWeek: jsii.String("dayOfWeek"),
				HandOffTime: jsii.String("handOffTime"),
			},
		},
	},
	StartTime: jsii.String("startTime"),
	TimeZoneId: jsii.String("timeZoneId"),

	// the properties below are optional
	Tags: []cfnTag{
		&cfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

type CfnRotation_CoverageTimeProperty 

type CfnRotation_CoverageTimeProperty struct {
	// Information about when an on-call rotation shift ends.
	EndTime *string `field:"required" json:"endTime" yaml:"endTime"`
	// Information about when an on-call rotation shift begins.
	StartTime *string `field:"required" json:"startTime" yaml:"startTime"`
}

Information about when an on-call shift begins and ends.

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"

coverageTimeProperty := &CoverageTimeProperty{
	EndTime: jsii.String("endTime"),
	StartTime: jsii.String("startTime"),
}

type CfnRotation_MonthlySettingProperty 

type CfnRotation_MonthlySettingProperty struct {
	// The day of the month when monthly recurring on-call rotations begin.
	DayOfMonth *float64 `field:"required" json:"dayOfMonth" yaml:"dayOfMonth"`
	// The time of day when a monthly recurring on-call shift rotation begins.
	HandOffTime *string `field:"required" json:"handOffTime" yaml:"handOffTime"`
}

Information about on-call rotations that recur monthly.

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"

monthlySettingProperty := &MonthlySettingProperty{
	DayOfMonth: jsii.Number(123),
	HandOffTime: jsii.String("handOffTime"),
}

type CfnRotation_RecurrenceSettingsProperty 

type CfnRotation_RecurrenceSettingsProperty struct {
	// The number of contacts, or shift team members designated to be on call concurrently during a shift.
	//
	// For example, in an on-call schedule that contains ten contacts, a value of `2` designates that two of them are on call at any given time.
	NumberOfOnCalls *float64 `field:"required" json:"numberOfOnCalls" yaml:"numberOfOnCalls"`
	// The number of days, weeks, or months a single rotation lasts.
	RecurrenceMultiplier *float64 `field:"required" json:"recurrenceMultiplier" yaml:"recurrenceMultiplier"`
	// Information about on-call rotations that recur daily.
	DailySettings *[]*string `field:"optional" json:"dailySettings" yaml:"dailySettings"`
	// Information about on-call rotations that recur monthly.
	MonthlySettings interface{} `field:"optional" json:"monthlySettings" yaml:"monthlySettings"`
	// Information about the days of the week included in on-call rotation coverage.
	ShiftCoverages interface{} `field:"optional" json:"shiftCoverages" yaml:"shiftCoverages"`
	// Information about on-call rotations that recur weekly.
	WeeklySettings interface{} `field:"optional" json:"weeklySettings" yaml:"weeklySettings"`
}

Information about when an on-call rotation is in effect and how long the rotation period lasts.

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"

recurrenceSettingsProperty := &RecurrenceSettingsProperty{
	NumberOfOnCalls: jsii.Number(123),
	RecurrenceMultiplier: jsii.Number(123),

	// the properties below are optional
	DailySettings: []*string{
		jsii.String("dailySettings"),
	},
	MonthlySettings: []interface{}{
		&MonthlySettingProperty{
			DayOfMonth: jsii.Number(123),
			HandOffTime: jsii.String("handOffTime"),
		},
	},
	ShiftCoverages: []interface{}{
		&ShiftCoverageProperty{
			CoverageTimes: []interface{}{
				&CoverageTimeProperty{
					EndTime: jsii.String("endTime"),
					StartTime: jsii.String("startTime"),
				},
			},
			DayOfWeek: jsii.String("dayOfWeek"),
		},
	},
	WeeklySettings: []interface{}{
		&WeeklySettingProperty{
			DayOfWeek: jsii.String("dayOfWeek"),
			HandOffTime: jsii.String("handOffTime"),
		},
	},
}

type CfnRotation_ShiftCoverageProperty 

type CfnRotation_ShiftCoverageProperty struct {
	// The start and end times of the shift.
	CoverageTimes interface{} `field:"required" json:"coverageTimes" yaml:"coverageTimes"`
	// A list of days on which the schedule is active.
	DayOfWeek *string `field:"required" json:"dayOfWeek" yaml:"dayOfWeek"`
}

Information about the days of the week that the on-call rotation coverage includes.

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"

shiftCoverageProperty := &ShiftCoverageProperty{
	CoverageTimes: []interface{}{
		&CoverageTimeProperty{
			EndTime: jsii.String("endTime"),
			StartTime: jsii.String("startTime"),
		},
	},
	DayOfWeek: jsii.String("dayOfWeek"),
}

type CfnRotation_WeeklySettingProperty 

type CfnRotation_WeeklySettingProperty struct {
	// The day of the week when weekly recurring on-call shift rotations begins.
	DayOfWeek *string `field:"required" json:"dayOfWeek" yaml:"dayOfWeek"`
	// The time of day when a weekly recurring on-call shift rotation begins.
	HandOffTime *string `field:"required" json:"handOffTime" yaml:"handOffTime"`
}

Information about rotations that recur weekly.

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"

weeklySettingProperty := &WeeklySettingProperty{
	DayOfWeek: jsii.String("dayOfWeek"),
	HandOffTime: jsii.String("handOffTime"),
}

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.