Documentation ¶
Index ¶
- func CfnContactChannel_CFN_RESOURCE_TYPE_NAME() *string
- func CfnContactChannel_IsCfnElement(x interface{}) *bool
- func CfnContactChannel_IsCfnResource(x interface{}) *bool
- func CfnContactChannel_IsConstruct(x interface{}) *bool
- func CfnContact_CFN_RESOURCE_TYPE_NAME() *string
- func CfnContact_IsCfnElement(x interface{}) *bool
- func CfnContact_IsCfnResource(x interface{}) *bool
- func CfnContact_IsConstruct(x interface{}) *bool
- func CfnPlan_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPlan_IsCfnElement(x interface{}) *bool
- func CfnPlan_IsCfnResource(x interface{}) *bool
- func CfnPlan_IsConstruct(x interface{}) *bool
- func CfnRotation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnRotation_IsCfnElement(x interface{}) *bool
- func CfnRotation_IsCfnResource(x interface{}) *bool
- func CfnRotation_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)
- func NewCfnPlan_Override(c CfnPlan, scope constructs.Construct, id *string, props *CfnPlanProps)
- func NewCfnRotation_Override(c CfnRotation, scope constructs.Construct, id *string, props *CfnRotationProps)
- type CfnContact
- type CfnContactChannel
- type CfnContactChannelProps
- type CfnContactProps
- type CfnContact_ChannelTargetInfoProperty
- type CfnContact_ContactTargetInfoProperty
- type CfnContact_StageProperty
- type CfnContact_TargetsProperty
- type CfnPlan
- type CfnPlanProps
- type CfnPlan_ChannelTargetInfoProperty
- type CfnPlan_ContactTargetInfoProperty
- type CfnPlan_StageProperty
- type CfnPlan_TargetsProperty
- type CfnRotation
- type CfnRotationProps
- type CfnRotation_CoverageTimeProperty
- type CfnRotation_MonthlySettingProperty
- type CfnRotation_RecurrenceSettingsProperty
- type CfnRotation_ShiftCoverageProperty
- type CfnRotation_WeeklySettingProperty
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.
func CfnContactChannel_IsCfnResource ¶
func CfnContactChannel_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnContactChannel_IsConstruct ¶
func CfnContactChannel_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 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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnContact_IsConstruct ¶
func CfnContact_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 CfnPlan_CFN_RESOURCE_TYPE_NAME ¶ added in v2.78.0
func CfnPlan_CFN_RESOURCE_TYPE_NAME() *string
func CfnPlan_IsCfnElement ¶ added in v2.78.0
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.
func CfnPlan_IsCfnResource ¶ added in v2.78.0
func CfnPlan_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnPlan_IsConstruct ¶ added in v2.78.0
func CfnPlan_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 CfnRotation_CFN_RESOURCE_TYPE_NAME ¶ added in v2.78.0
func CfnRotation_CFN_RESOURCE_TYPE_NAME() *string
func CfnRotation_IsCfnElement ¶ added in v2.78.0
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.
func CfnRotation_IsCfnResource ¶ added in v2.78.0
func CfnRotation_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnRotation_IsConstruct ¶ added in v2.78.0
func CfnRotation_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 NewCfnContactChannel_Override ¶
func NewCfnContactChannel_Override(c CfnContactChannel, scope constructs.Construct, id *string, props *CfnContactChannelProps)
func NewCfnContact_Override ¶
func NewCfnContact_Override(c CfnContact, scope constructs.Construct, id *string, props *CfnContactProps)
func NewCfnPlan_Override ¶ added in v2.78.0
func NewCfnPlan_Override(c CfnPlan, scope constructs.Construct, id *string, props *CfnPlanProps)
func NewCfnRotation_Override ¶ added in v2.78.0
func NewCfnRotation_Override(c CfnRotation, scope constructs.Construct, id *string, props *CfnRotationProps)
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. 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 // 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. LogicalId() *string // The tree node. Node() constructs.Node // A list of stages. 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The type of contact. Type() *string SetType(val *string) // 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{}) }
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), }, }, }, }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html
func NewCfnContact ¶
func NewCfnContact(scope constructs.Construct, id *string, props *CfnContactProps) CfnContact
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. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. 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:. 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. CreationStack() *[]*string // If you want to activate the channel at a later time, you can choose to defer activation. 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. 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 // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // 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{}) }
The `AWS::SSMContacts::ContactChannel` resource specifies a contact channel as the method that Incident Manager uses to engage your contact.
> *Template example* : We recommend creating all Incident Manager `Contacts` resources using a single AWS CloudFormation template. For a demonstration, see the examples for [AWS::SSMContacts::Contacts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html) .
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 constructs.Construct, id *string, props *CfnContactChannelProps) CfnContactChannel
type CfnContactChannelProps ¶
type CfnContactChannelProps struct { // The details that Incident Manager uses when trying to engage the contact channel. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contactchannel.html#cfn-ssmcontacts-contactchannel-channeladdress // ChannelAddress *string `field:"required" json:"channelAddress" yaml:"channelAddress"` // The name of the contact channel. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contactchannel.html#cfn-ssmcontacts-contactchannel-channelname // ChannelName *string `field:"required" json:"channelName" yaml:"channelName"` // The type of the contact channel. Incident Manager supports three contact methods:. // // - SMS // - VOICE // - EMAIL. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contactchannel.html#cfn-ssmcontacts-contactchannel-channeltype // ChannelType *string `field:"required" json:"channelType" yaml:"channelType"` // The Amazon Resource Name (ARN) of the contact you are adding the contact channel to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contactchannel.html#cfn-ssmcontacts-contactchannel-contactid // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contactchannel.html#cfn-ssmcontacts-contactchannel-deferactivation // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html#cfn-ssmcontacts-contact-alias // Alias *string `field:"required" json:"alias" yaml:"alias"` // The full name of the contact or escalation plan. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html#cfn-ssmcontacts-contact-displayname // DisplayName *string `field:"required" json:"displayName" yaml:"displayName"` // The type of contact. // // - `PERSONAL` : A single, individual contact. // - `ESCALATION` : An escalation plan. // - `ONCALL_SCHEDULE` : An on-call schedule. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html#cfn-ssmcontacts-contact-type // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html#cfn-ssmcontacts-contact-plan // 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), }, }, }, }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html
type CfnContact_ChannelTargetInfoProperty ¶
type CfnContact_ChannelTargetInfoProperty struct { // The Amazon Resource Name (ARN) of the contact channel. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-channeltargetinfo.html#cfn-ssmcontacts-contact-channeltargetinfo-channelid // ChannelId *string `field:"required" json:"channelId" yaml:"channelId"` // The number of minutes to wait before retrying to send engagement if the engagement initially failed. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-channeltargetinfo.html#cfn-ssmcontacts-contact-channeltargetinfo-retryintervalinminutes // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-contacttargetinfo.html#cfn-ssmcontacts-contact-contacttargetinfo-contactid // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-contacttargetinfo.html#cfn-ssmcontacts-contact-contacttargetinfo-isessential // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-stage.html#cfn-ssmcontacts-contact-stage-durationinminutes // DurationInMinutes *float64 `field:"optional" json:"durationInMinutes" yaml:"durationInMinutes"` // The Amazon Resource Names (ARNs) of the on-call rotations associated with the plan. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-stage.html#cfn-ssmcontacts-contact-stage-rotationids // RotationIds *[]*string `field:"optional" json:"rotationIds" yaml:"rotationIds"` // The contacts or contact methods that the escalation plan or engagement plan is engaging. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-stage.html#cfn-ssmcontacts-contact-stage-targets // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-targets.html#cfn-ssmcontacts-contact-targets-channeltargetinfo // ChannelTargetInfo interface{} `field:"optional" json:"channelTargetInfo" yaml:"channelTargetInfo"` // The contact that Incident Manager is engaging during an incident. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-targets.html#cfn-ssmcontacts-contact-targets-contacttargetinfo // 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 ¶ added in v2.78.0
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. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. 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. 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. 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 // 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). 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{}) // 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{}) }
Information about the stages and on-call rotation teams associated with an escalation plan or engagement plan.
> *Template example* : We recommend creating all Incident Manager `Contacts` resources using a single AWS CloudFormation template. For a demonstration, see the examples for [AWS::SSMContacts::Contacts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html) .
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), }, }, }, }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-plan.html
func NewCfnPlan ¶ added in v2.78.0
func NewCfnPlan(scope constructs.Construct, id *string, props *CfnPlanProps) CfnPlan
type CfnPlanProps ¶ added in v2.78.0
type CfnPlanProps struct { // The Amazon Resource Name (ARN) of the contact. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-plan.html#cfn-ssmcontacts-plan-contactid // ContactId *string `field:"required" json:"contactId" yaml:"contactId"` // The Amazon Resource Names (ARNs) of the on-call rotations associated with the plan. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-plan.html#cfn-ssmcontacts-plan-rotationids // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-plan.html#cfn-ssmcontacts-plan-stages // 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), }, }, }, }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-plan.html
type CfnPlan_ChannelTargetInfoProperty ¶ added in v2.78.0
type CfnPlan_ChannelTargetInfoProperty struct { // The Amazon Resource Name (ARN) of the contact channel. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-channeltargetinfo.html#cfn-ssmcontacts-plan-channeltargetinfo-channelid // ChannelId *string `field:"required" json:"channelId" yaml:"channelId"` // The number of minutes to wait before retrying to send engagement if the engagement initially failed. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-channeltargetinfo.html#cfn-ssmcontacts-plan-channeltargetinfo-retryintervalinminutes // 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 ¶ added in v2.78.0
type CfnPlan_ContactTargetInfoProperty struct { // The Amazon Resource Name (ARN) of the contact. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-contacttargetinfo.html#cfn-ssmcontacts-plan-contacttargetinfo-contactid // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-contacttargetinfo.html#cfn-ssmcontacts-plan-contacttargetinfo-isessential // 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 ¶ added in v2.78.0
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-stage.html#cfn-ssmcontacts-plan-stage-durationinminutes // DurationInMinutes *float64 `field:"required" json:"durationInMinutes" yaml:"durationInMinutes"` // The contacts or contact methods that the escalation plan or engagement plan is engaging. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-stage.html#cfn-ssmcontacts-plan-stage-targets // 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 ¶ added in v2.78.0
type CfnPlan_TargetsProperty struct { // Information about the contact channel that Incident Manager engages. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-targets.html#cfn-ssmcontacts-plan-targets-channeltargetinfo // ChannelTargetInfo interface{} `field:"optional" json:"channelTargetInfo" yaml:"channelTargetInfo"` // Information about the contact that Incident Manager engages. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-targets.html#cfn-ssmcontacts-plan-targets-contacttargetinfo // 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 ¶ added in v2.78.0
type CfnRotation interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The Amazon Resource Name (ARN) of the `Rotation` resource. 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 Amazon Resource Names (ARNs) of the contacts to add to the rotation. 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. 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. LogicalId() *string // The name for the rotation. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The date and time the rotation goes into effect. StartTime() *string SetStartTime(val *string) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // Optional metadata to assign to the rotation. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // The time zone to base the rotation’s activity on, in Internet Assigned Numbers Authority (IANA) format. TimeZoneId() *string SetTimeZoneId(val *string) // 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{}) }
Specifies a rotation in an on-call schedule.
> *Template example* : We recommend creating all Incident Manager `Contacts` resources using a single AWS CloudFormation template. For a demonstration, see the examples for [AWS::SSMContacts::Contacts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html) .
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"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html
func NewCfnRotation ¶ added in v2.78.0
func NewCfnRotation(scope constructs.Construct, id *string, props *CfnRotationProps) CfnRotation
type CfnRotationProps ¶ added in v2.78.0
type CfnRotationProps struct { // The Amazon Resource Names (ARNs) of the contacts to add to the rotation. // // > Only the `PERSONAL` contact type is supported. The contact types `ESCALATION` and `ONCALL_SCHEDULE` are not supported for this operation. // // The order in which you list the contacts is their shift order in the rotation schedule. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html#cfn-ssmcontacts-rotation-contactids // ContactIds *[]*string `field:"required" json:"contactIds" yaml:"contactIds"` // The name for the rotation. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html#cfn-ssmcontacts-rotation-name // Name *string `field:"required" json:"name" yaml:"name"` // Information about the rule that specifies when shift team members rotate. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html#cfn-ssmcontacts-rotation-recurrence // Recurrence interface{} `field:"required" json:"recurrence" yaml:"recurrence"` // The date and time the rotation goes into effect. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html#cfn-ssmcontacts-rotation-starttime // 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. // // > Designators for time zones that don’t support Daylight Savings Time rules, such as Pacific Standard Time (PST), are not supported. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html#cfn-ssmcontacts-rotation-timezoneid // 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html#cfn-ssmcontacts-rotation-tags // 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"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-rotation.html
type CfnRotation_CoverageTimeProperty ¶ added in v2.78.0
type CfnRotation_CoverageTimeProperty struct { // Information about when an on-call rotation shift ends. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-coveragetime.html#cfn-ssmcontacts-rotation-coveragetime-endtime // EndTime *string `field:"required" json:"endTime" yaml:"endTime"` // Information about when an on-call rotation shift begins. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-coveragetime.html#cfn-ssmcontacts-rotation-coveragetime-starttime // 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 ¶ added in v2.78.0
type CfnRotation_MonthlySettingProperty struct { // The day of the month when monthly recurring on-call rotations begin. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-monthlysetting.html#cfn-ssmcontacts-rotation-monthlysetting-dayofmonth // DayOfMonth *float64 `field:"required" json:"dayOfMonth" yaml:"dayOfMonth"` // The time of day when a monthly recurring on-call shift rotation begins. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-monthlysetting.html#cfn-ssmcontacts-rotation-monthlysetting-handofftime // 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 ¶ added in v2.78.0
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-recurrencesettings.html#cfn-ssmcontacts-rotation-recurrencesettings-numberofoncalls // NumberOfOnCalls *float64 `field:"required" json:"numberOfOnCalls" yaml:"numberOfOnCalls"` // The number of days, weeks, or months a single rotation lasts. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-recurrencesettings.html#cfn-ssmcontacts-rotation-recurrencesettings-recurrencemultiplier // RecurrenceMultiplier *float64 `field:"required" json:"recurrenceMultiplier" yaml:"recurrenceMultiplier"` // Information about on-call rotations that recur daily. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-recurrencesettings.html#cfn-ssmcontacts-rotation-recurrencesettings-dailysettings // DailySettings *[]*string `field:"optional" json:"dailySettings" yaml:"dailySettings"` // Information about on-call rotations that recur monthly. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-recurrencesettings.html#cfn-ssmcontacts-rotation-recurrencesettings-monthlysettings // MonthlySettings interface{} `field:"optional" json:"monthlySettings" yaml:"monthlySettings"` // Information about the days of the week included in on-call rotation coverage. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-recurrencesettings.html#cfn-ssmcontacts-rotation-recurrencesettings-shiftcoverages // ShiftCoverages interface{} `field:"optional" json:"shiftCoverages" yaml:"shiftCoverages"` // Information about on-call rotations that recur weekly. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-recurrencesettings.html#cfn-ssmcontacts-rotation-recurrencesettings-weeklysettings // 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 ¶ added in v2.78.0
type CfnRotation_ShiftCoverageProperty struct { // The start and end times of the shift. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-shiftcoverage.html#cfn-ssmcontacts-rotation-shiftcoverage-coveragetimes // CoverageTimes interface{} `field:"required" json:"coverageTimes" yaml:"coverageTimes"` // A list of days on which the schedule is active. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-shiftcoverage.html#cfn-ssmcontacts-rotation-shiftcoverage-dayofweek // 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 ¶ added in v2.78.0
type CfnRotation_WeeklySettingProperty struct { // The day of the week when weekly recurring on-call shift rotations begins. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-weeklysetting.html#cfn-ssmcontacts-rotation-weeklysetting-dayofweek // DayOfWeek *string `field:"required" json:"dayOfWeek" yaml:"dayOfWeek"` // The time of day when a weekly recurring on-call shift rotation begins. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-rotation-weeklysetting.html#cfn-ssmcontacts-rotation-weeklysetting-handofftime // 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 ¶
- CfnContact.go
- CfnContactChannel.go
- CfnContactChannelProps.go
- CfnContactChannel__checks.go
- CfnContactProps.go
- CfnContact_ChannelTargetInfoProperty.go
- CfnContact_ContactTargetInfoProperty.go
- CfnContact_StageProperty.go
- CfnContact_TargetsProperty.go
- CfnContact__checks.go
- CfnPlan.go
- CfnPlanProps.go
- CfnPlan_ChannelTargetInfoProperty.go
- CfnPlan_ContactTargetInfoProperty.go
- CfnPlan_StageProperty.go
- CfnPlan_TargetsProperty.go
- CfnPlan__checks.go
- CfnRotation.go
- CfnRotationProps.go
- CfnRotation_CoverageTimeProperty.go
- CfnRotation_MonthlySettingProperty.go
- CfnRotation_RecurrenceSettingsProperty.go
- CfnRotation_ShiftCoverageProperty.go
- CfnRotation_WeeklySettingProperty.go
- CfnRotation__checks.go
- main.go