awsssmcontacts

Documentation

Index

• func CfnContactChannel_CFN_RESOURCE_TYPE_NAME() *string
• func CfnContactChannel_IsCfnElement(x interface{}) *bool
• func CfnContactChannel_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnContactChannel_IsConstruct(x interface{}) *bool
• func CfnContact_CFN_RESOURCE_TYPE_NAME() *string
• func CfnContact_IsCfnElement(x interface{}) *bool
• func CfnContact_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnContact_IsConstruct(x interface{}) *bool
• func NewCfnContactChannel_Override(c CfnContactChannel, scope constructs.Construct, id *string, ...)
• func NewCfnContact_Override(c CfnContact, scope constructs.Construct, id *string, props *CfnContactProps)
• type CfnContact
  • func NewCfnContact(scope constructs.Construct, id *string, props *CfnContactProps) CfnContact
• type CfnContactChannel
  • func NewCfnContactChannel(scope constructs.Construct, id *string, props *CfnContactChannelProps) CfnContactChannel
• type CfnContactChannelProps
• type CfnContactProps
• type CfnContact_ChannelTargetInfoProperty
• type CfnContact_ContactTargetInfoProperty
• type CfnContact_StageProperty
• type CfnContact_TargetsProperty

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.

func CfnContactChannel_IsCfnResource

func CfnContactChannel_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnContactChannel_IsConstruct

func CfnContactChannel_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

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

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.

func CfnContact_IsCfnResource

func CfnContact_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnContact_IsConstruct

func CfnContact_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

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

func NewCfnContactChannel_Override

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

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

func NewCfnContact_Override

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

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

Types

type CfnContact

type CfnContact interface {
	awscdk.CfnResource
	awscdk.IInspectable
	Alias() *string
	SetAlias(val *string)
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DisplayName() *string
	SetDisplayName(val *string)
	LogicalId() *string
	Node() constructs.Node
	Plan() interface{}
	SetPlan(val interface{})
	Ref() *string
	Stack() awscdk.Stack
	Type() *string
	SetType(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	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.

TODO: EXAMPLE

func NewCfnContact

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

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

type CfnContactChannel

type CfnContactChannel interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ChannelAddress() *string
	SetChannelAddress(val *string)
	ChannelName() *string
	SetChannelName(val *string)
	ChannelType() *string
	SetChannelType(val *string)
	ContactId() *string
	SetContactId(val *string)
	CreationStack() *[]*string
	DeferActivation() interface{}
	SetDeferActivation(val interface{})
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	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.

TODO: EXAMPLE

func NewCfnContactChannel

func NewCfnContactChannel(scope constructs.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 `json:"channelAddress" yaml:"channelAddress"`
	// The name of the contact channel.
	ChannelName *string `json:"channelName" yaml:"channelName"`
	// The type of the contact channel. Incident Manager supports three contact methods:.
	//
	// - SMS
	// - VOICE
	// - EMAIL
	ChannelType *string `json:"channelType" yaml:"channelType"`
	// The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.
	ContactId *string `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{} `json:"deferActivation" yaml:"deferActivation"`
}

Properties for defining a `CfnContactChannel`.

TODO: EXAMPLE

type CfnContactProps

type CfnContactProps struct {
	// The unique and identifiable alias of the contact or escalation plan.
	Alias *string `json:"alias" yaml:"alias"`
	// The full name of the contact or escalation plan.
	DisplayName *string `json:"displayName" yaml:"displayName"`
	// 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{} `json:"plan" yaml:"plan"`
	// Refers to the type of contact.
	//
	// A single contact is type `PERSONAL` and an escalation plan is type `ESCALATION` .
	Type *string `json:"type" yaml:"type"`
}

Properties for defining a `CfnContact`.

TODO: EXAMPLE

type CfnContact_ChannelTargetInfoProperty

type CfnContact_ChannelTargetInfoProperty struct {
	// The Amazon Resource Name (ARN) of the contact channel.
	ChannelId *string `json:"channelId" yaml:"channelId"`
	// The number of minutes to wait to retry sending engagement in the case the engagement initially fails.
	RetryIntervalInMinutes *float64 `json:"retryIntervalInMinutes" yaml:"retryIntervalInMinutes"`
}

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

TODO: EXAMPLE

type CfnContact_ContactTargetInfoProperty

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

The contact that Incident Manager is engaging during an incident.

TODO: EXAMPLE

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 `json:"durationInMinutes" yaml:"durationInMinutes"`
	// The contacts or contact methods that the escalation plan or engagement plan is engaging.
	Targets interface{} `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.

TODO: EXAMPLE

type CfnContact_TargetsProperty

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

The contact or contact channel that's being engaged.

TODO: EXAMPLE