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. 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

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. 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

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`.

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`.

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 {
	// `AWS::SSMContacts::ContactChannel.ChannelAddress`.
	ChannelAddress *string `json:"channelAddress"`
	// `AWS::SSMContacts::ContactChannel.ChannelName`.
	ChannelName *string `json:"channelName"`
	// `AWS::SSMContacts::ContactChannel.ChannelType`.
	ChannelType *string `json:"channelType"`
	// `AWS::SSMContacts::ContactChannel.ContactId`.
	ContactId *string `json:"contactId"`
	// `AWS::SSMContacts::ContactChannel.DeferActivation`.
	DeferActivation interface{} `json:"deferActivation"`
}

Properties for defining a `AWS::SSMContacts::ContactChannel`.

TODO: EXAMPLE

type CfnContactProps

type CfnContactProps struct {
	// `AWS::SSMContacts::Contact.Alias`.
	Alias *string `json:"alias"`
	// `AWS::SSMContacts::Contact.DisplayName`.
	DisplayName *string `json:"displayName"`
	// `AWS::SSMContacts::Contact.Plan`.
	Plan interface{} `json:"plan"`
	// `AWS::SSMContacts::Contact.Type`.
	Type *string `json:"type"`
}

Properties for defining a `AWS::SSMContacts::Contact`.

TODO: EXAMPLE

type CfnContact_ChannelTargetInfoProperty

type CfnContact_ChannelTargetInfoProperty struct {
	// `CfnContact.ChannelTargetInfoProperty.ChannelId`.
	ChannelId *string `json:"channelId"`
	// `CfnContact.ChannelTargetInfoProperty.RetryIntervalInMinutes`.
	RetryIntervalInMinutes *float64 `json:"retryIntervalInMinutes"`
}

TODO: EXAMPLE

type CfnContact_ContactTargetInfoProperty

type CfnContact_ContactTargetInfoProperty struct {
	// `CfnContact.ContactTargetInfoProperty.ContactId`.
	ContactId *string `json:"contactId"`
	// `CfnContact.ContactTargetInfoProperty.IsEssential`.
	IsEssential interface{} `json:"isEssential"`
}

TODO: EXAMPLE

type CfnContact_StageProperty

type CfnContact_StageProperty struct {
	// `CfnContact.StageProperty.DurationInMinutes`.
	DurationInMinutes *float64 `json:"durationInMinutes"`
	// `CfnContact.StageProperty.Targets`.
	Targets interface{} `json:"targets"`
}

TODO: EXAMPLE

type CfnContact_TargetsProperty

type CfnContact_TargetsProperty struct {
	// `CfnContact.TargetsProperty.ChannelTargetInfo`.
	ChannelTargetInfo interface{} `json:"channelTargetInfo"`
	// `CfnContact.TargetsProperty.ContactTargetInfo`.
	ContactTargetInfo interface{} `json:"contactTargetInfo"`
}

TODO: EXAMPLE