Documentation
¶
Index ¶
- func CfnContactFlowModule_CFN_RESOURCE_TYPE_NAME() *string
- func CfnContactFlowModule_IsCfnElement(x interface{}) *bool
- func CfnContactFlowModule_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnContactFlowModule_IsConstruct(x interface{}) *bool
- func CfnContactFlow_CFN_RESOURCE_TYPE_NAME() *string
- func CfnContactFlow_IsCfnElement(x interface{}) *bool
- func CfnContactFlow_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnContactFlow_IsConstruct(x interface{}) *bool
- func CfnHoursOfOperation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnHoursOfOperation_IsCfnElement(x interface{}) *bool
- func CfnHoursOfOperation_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnHoursOfOperation_IsConstruct(x interface{}) *bool
- func CfnPhoneNumber_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPhoneNumber_IsCfnElement(x interface{}) *bool
- func CfnPhoneNumber_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnPhoneNumber_IsConstruct(x interface{}) *bool
- func CfnQuickConnect_CFN_RESOURCE_TYPE_NAME() *string
- func CfnQuickConnect_IsCfnElement(x interface{}) *bool
- func CfnQuickConnect_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnQuickConnect_IsConstruct(x interface{}) *bool
- func CfnTaskTemplate_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTaskTemplate_IsCfnElement(x interface{}) *bool
- func CfnTaskTemplate_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnTaskTemplate_IsConstruct(x interface{}) *bool
- func CfnUserHierarchyGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnUserHierarchyGroup_IsCfnElement(x interface{}) *bool
- func CfnUserHierarchyGroup_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnUserHierarchyGroup_IsConstruct(x interface{}) *bool
- func CfnUser_CFN_RESOURCE_TYPE_NAME() *string
- func CfnUser_IsCfnElement(x interface{}) *bool
- func CfnUser_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnUser_IsConstruct(x interface{}) *bool
- func NewCfnContactFlowModule_Override(c CfnContactFlowModule, scope awscdk.Construct, id *string, ...)
- func NewCfnContactFlow_Override(c CfnContactFlow, scope awscdk.Construct, id *string, ...)
- func NewCfnHoursOfOperation_Override(c CfnHoursOfOperation, scope awscdk.Construct, id *string, ...)
- func NewCfnPhoneNumber_Override(c CfnPhoneNumber, scope awscdk.Construct, id *string, ...)
- func NewCfnQuickConnect_Override(c CfnQuickConnect, scope awscdk.Construct, id *string, ...)
- func NewCfnTaskTemplate_Override(c CfnTaskTemplate, scope awscdk.Construct, id *string, ...)
- func NewCfnUserHierarchyGroup_Override(c CfnUserHierarchyGroup, scope awscdk.Construct, id *string, ...)
- func NewCfnUser_Override(c CfnUser, scope awscdk.Construct, id *string, props *CfnUserProps)
- type CfnContactFlow
- type CfnContactFlowModule
- type CfnContactFlowModuleProps
- type CfnContactFlowProps
- type CfnHoursOfOperation
- type CfnHoursOfOperationProps
- type CfnHoursOfOperation_HoursOfOperationConfigProperty
- type CfnHoursOfOperation_HoursOfOperationTimeSliceProperty
- type CfnPhoneNumber
- type CfnPhoneNumberProps
- type CfnQuickConnect
- type CfnQuickConnectProps
- type CfnQuickConnect_PhoneNumberQuickConnectConfigProperty
- type CfnQuickConnect_QueueQuickConnectConfigProperty
- type CfnQuickConnect_QuickConnectConfigProperty
- type CfnQuickConnect_UserQuickConnectConfigProperty
- type CfnTaskTemplate
- type CfnTaskTemplateProps
- type CfnTaskTemplate_DefaultFieldValueProperty
- type CfnTaskTemplate_FieldIdentifierProperty
- type CfnTaskTemplate_FieldProperty
- type CfnUser
- type CfnUserHierarchyGroup
- type CfnUserHierarchyGroupProps
- type CfnUserProps
- type CfnUser_UserIdentityInfoProperty
- type CfnUser_UserPhoneConfigProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnContactFlowModule_CFN_RESOURCE_TYPE_NAME ¶
func CfnContactFlowModule_CFN_RESOURCE_TYPE_NAME() *string
func CfnContactFlowModule_IsCfnElement ¶
func CfnContactFlowModule_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 CfnContactFlowModule_IsCfnResource ¶
func CfnContactFlowModule_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnContactFlowModule_IsConstruct ¶
func CfnContactFlowModule_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnContactFlow_CFN_RESOURCE_TYPE_NAME ¶
func CfnContactFlow_CFN_RESOURCE_TYPE_NAME() *string
func CfnContactFlow_IsCfnElement ¶
func CfnContactFlow_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 CfnContactFlow_IsCfnResource ¶
func CfnContactFlow_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnContactFlow_IsConstruct ¶
func CfnContactFlow_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnHoursOfOperation_CFN_RESOURCE_TYPE_NAME ¶
func CfnHoursOfOperation_CFN_RESOURCE_TYPE_NAME() *string
func CfnHoursOfOperation_IsCfnElement ¶
func CfnHoursOfOperation_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 CfnHoursOfOperation_IsCfnResource ¶
func CfnHoursOfOperation_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnHoursOfOperation_IsConstruct ¶
func CfnHoursOfOperation_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnPhoneNumber_CFN_RESOURCE_TYPE_NAME ¶
func CfnPhoneNumber_CFN_RESOURCE_TYPE_NAME() *string
func CfnPhoneNumber_IsCfnElement ¶
func CfnPhoneNumber_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 CfnPhoneNumber_IsCfnResource ¶
func CfnPhoneNumber_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnPhoneNumber_IsConstruct ¶
func CfnPhoneNumber_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnQuickConnect_CFN_RESOURCE_TYPE_NAME ¶
func CfnQuickConnect_CFN_RESOURCE_TYPE_NAME() *string
func CfnQuickConnect_IsCfnElement ¶
func CfnQuickConnect_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 CfnQuickConnect_IsCfnResource ¶
func CfnQuickConnect_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnQuickConnect_IsConstruct ¶
func CfnQuickConnect_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnTaskTemplate_CFN_RESOURCE_TYPE_NAME ¶
func CfnTaskTemplate_CFN_RESOURCE_TYPE_NAME() *string
func CfnTaskTemplate_IsCfnElement ¶
func CfnTaskTemplate_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 CfnTaskTemplate_IsCfnResource ¶
func CfnTaskTemplate_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnTaskTemplate_IsConstruct ¶
func CfnTaskTemplate_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnUserHierarchyGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnUserHierarchyGroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnUserHierarchyGroup_IsCfnElement ¶
func CfnUserHierarchyGroup_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 CfnUserHierarchyGroup_IsCfnResource ¶
func CfnUserHierarchyGroup_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnUserHierarchyGroup_IsConstruct ¶
func CfnUserHierarchyGroup_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnUser_CFN_RESOURCE_TYPE_NAME ¶
func CfnUser_CFN_RESOURCE_TYPE_NAME() *string
func CfnUser_IsCfnElement ¶
func CfnUser_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 CfnUser_IsCfnResource ¶
func CfnUser_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnUser_IsConstruct ¶
func CfnUser_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func NewCfnContactFlowModule_Override ¶
func NewCfnContactFlowModule_Override(c CfnContactFlowModule, scope awscdk.Construct, id *string, props *CfnContactFlowModuleProps)
Create a new `AWS::Connect::ContactFlowModule`.
func NewCfnContactFlow_Override ¶
func NewCfnContactFlow_Override(c CfnContactFlow, scope awscdk.Construct, id *string, props *CfnContactFlowProps)
Create a new `AWS::Connect::ContactFlow`.
func NewCfnHoursOfOperation_Override ¶
func NewCfnHoursOfOperation_Override(c CfnHoursOfOperation, scope awscdk.Construct, id *string, props *CfnHoursOfOperationProps)
Create a new `AWS::Connect::HoursOfOperation`.
func NewCfnPhoneNumber_Override ¶
func NewCfnPhoneNumber_Override(c CfnPhoneNumber, scope awscdk.Construct, id *string, props *CfnPhoneNumberProps)
Create a new `AWS::Connect::PhoneNumber`.
func NewCfnQuickConnect_Override ¶
func NewCfnQuickConnect_Override(c CfnQuickConnect, scope awscdk.Construct, id *string, props *CfnQuickConnectProps)
Create a new `AWS::Connect::QuickConnect`.
func NewCfnTaskTemplate_Override ¶
func NewCfnTaskTemplate_Override(c CfnTaskTemplate, scope awscdk.Construct, id *string, props *CfnTaskTemplateProps)
Create a new `AWS::Connect::TaskTemplate`.
func NewCfnUserHierarchyGroup_Override ¶
func NewCfnUserHierarchyGroup_Override(c CfnUserHierarchyGroup, scope awscdk.Construct, id *string, props *CfnUserHierarchyGroupProps)
Create a new `AWS::Connect::UserHierarchyGroup`.
func NewCfnUser_Override ¶
func NewCfnUser_Override(c CfnUser, scope awscdk.Construct, id *string, props *CfnUserProps)
Create a new `AWS::Connect::User`.
Types ¶
type CfnContactFlow ¶
type CfnContactFlow interface {
awscdk.CfnResource
awscdk.IInspectable
// `Ref` returns the contact flow Amazon Resource Name (ARN). For example:.
//
// `{ "Ref": "myContactFlowArn" }`.
AttrContactFlowArn() *string
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *string
// The content of the contact flow.
Content() *string
SetContent(val *string)
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
// Experimental.
CreationStack() *[]*string
// The description of the contact flow.
Description() *string
SetDescription(val *string)
// The Amazon Resource Name (ARN) of the Amazon Connect instance.
InstanceArn() *string
SetInstanceArn(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
// Experimental.
LogicalId() *string
// The name of the contact flow.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// The state of the contact flow.
State() *string
SetState(val *string)
// An array of key-value pairs to apply to this resource.
//
// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
Tags() awscdk.TagManager
// The type of the contact flow.
//
// For descriptions of the available types, see [Choose a Contact Flow Type](https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types) in the *Amazon Connect Administrator Guide* .
Type() *string
SetType(val *string)
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
// Experimental.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
// Experimental.
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Connect::ContactFlow`.
The `AWS::Connect::ContactFlow` resource specifies a contact flow for the specified Amazon Connect instance.
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"
cfnContactFlow := awscdk.Aws_connect.NewCfnContactFlow(this, jsii.String("MyCfnContactFlow"), &cfnContactFlowProps{
content: jsii.String("content"),
instanceArn: jsii.String("instanceArn"),
name: jsii.String("name"),
// the properties below are optional
description: jsii.String("description"),
state: jsii.String("state"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
type: jsii.String("type"),
})
func NewCfnContactFlow ¶
func NewCfnContactFlow(scope awscdk.Construct, id *string, props *CfnContactFlowProps) CfnContactFlow
Create a new `AWS::Connect::ContactFlow`.
type CfnContactFlowModule ¶
type CfnContactFlowModule interface {
awscdk.CfnResource
awscdk.IInspectable
// `Ref` returns the contact flow module Amazon Resource Name (ARN). For example:.
//
// `{ "Ref": "myContactFlowModuleArn" }`.
AttrContactFlowModuleArn() *string
AttrStatus() *string
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *string
// The content of the contact flow module.
Content() *string
SetContent(val *string)
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
// Experimental.
CreationStack() *[]*string
// The description of the contact flow module.
Description() *string
SetDescription(val *string)
// The Amazon Resource Name (ARN) of the Amazon Connect instance.
InstanceArn() *string
SetInstanceArn(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
// Experimental.
LogicalId() *string
// The name of the contact flow module.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// The state of the contact flow module.
State() *string
SetState(val *string)
// An array of key-value pairs to apply to this resource.
//
// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
// Experimental.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
// Experimental.
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Connect::ContactFlowModule`.
The `AWS::Connect::ContactFlowModule` resource specifies a contact flow module for the specified Amazon Connect instance.
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"
cfnContactFlowModule := awscdk.Aws_connect.NewCfnContactFlowModule(this, jsii.String("MyCfnContactFlowModule"), &cfnContactFlowModuleProps{
content: jsii.String("content"),
instanceArn: jsii.String("instanceArn"),
name: jsii.String("name"),
// the properties below are optional
description: jsii.String("description"),
state: jsii.String("state"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
func NewCfnContactFlowModule ¶
func NewCfnContactFlowModule(scope awscdk.Construct, id *string, props *CfnContactFlowModuleProps) CfnContactFlowModule
Create a new `AWS::Connect::ContactFlowModule`.
type CfnContactFlowModuleProps ¶
type CfnContactFlowModuleProps struct {
// The content of the contact flow module.
Content *string `field:"required" json:"content" yaml:"content"`
// The Amazon Resource Name (ARN) of the Amazon Connect instance.
InstanceArn *string `field:"required" json:"instanceArn" yaml:"instanceArn"`
// The name of the contact flow module.
Name *string `field:"required" json:"name" yaml:"name"`
// The description of the contact flow module.
Description *string `field:"optional" json:"description" yaml:"description"`
// The state of the contact flow module.
State *string `field:"optional" json:"state" yaml:"state"`
// An array of key-value pairs to apply to this resource.
//
// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnContactFlowModule`.
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"
cfnContactFlowModuleProps := &cfnContactFlowModuleProps{
content: jsii.String("content"),
instanceArn: jsii.String("instanceArn"),
name: jsii.String("name"),
// the properties below are optional
description: jsii.String("description"),
state: jsii.String("state"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
type CfnContactFlowProps ¶
type CfnContactFlowProps struct {
// The content of the contact flow.
Content *string `field:"required" json:"content" yaml:"content"`
// The Amazon Resource Name (ARN) of the Amazon Connect instance.
InstanceArn *string `field:"required" json:"instanceArn" yaml:"instanceArn"`
// The name of the contact flow.
Name *string `field:"required" json:"name" yaml:"name"`
// The description of the contact flow.
Description *string `field:"optional" json:"description" yaml:"description"`
// The state of the contact flow.
State *string `field:"optional" json:"state" yaml:"state"`
// An array of key-value pairs to apply to this resource.
//
// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// The type of the contact flow.
//
// For descriptions of the available types, see [Choose a Contact Flow Type](https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types) in the *Amazon Connect Administrator Guide* .
Type *string `field:"optional" json:"type" yaml:"type"`
}
Properties for defining a `CfnContactFlow`.
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"
cfnContactFlowProps := &cfnContactFlowProps{
content: jsii.String("content"),
instanceArn: jsii.String("instanceArn"),
name: jsii.String("name"),
// the properties below are optional
description: jsii.String("description"),
state: jsii.String("state"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
type: jsii.String("type"),
}
type CfnHoursOfOperation ¶
type CfnHoursOfOperation interface {
awscdk.CfnResource
awscdk.IInspectable
// The Amazon Resource Name (ARN) for the hours of operation.
AttrHoursOfOperationArn() *string
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *string
// Configuration information for the hours of operation.
Config() interface{}
SetConfig(val interface{})
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
// Experimental.
CreationStack() *[]*string
// The description for the hours of operation.
Description() *string
SetDescription(val *string)
// The Amazon Resource Name (ARN) for the instance.
InstanceArn() *string
SetInstanceArn(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
// Experimental.
LogicalId() *string
// The name for the hours of operation.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// The tags used to organize, track, or control access for this resource.
Tags() awscdk.TagManager
// The time zone for the hours of operation.
TimeZone() *string
SetTimeZone(val *string)
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
// Experimental.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
// Experimental.
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Connect::HoursOfOperation`.
Creates hours of operation.
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"
cfnHoursOfOperation := awscdk.Aws_connect.NewCfnHoursOfOperation(this, jsii.String("MyCfnHoursOfOperation"), &cfnHoursOfOperationProps{
config: []interface{}{
&hoursOfOperationConfigProperty{
day: jsii.String("day"),
endTime: &hoursOfOperationTimeSliceProperty{
hours: jsii.Number(123),
minutes: jsii.Number(123),
},
startTime: &hoursOfOperationTimeSliceProperty{
hours: jsii.Number(123),
minutes: jsii.Number(123),
},
},
},
instanceArn: jsii.String("instanceArn"),
name: jsii.String("name"),
timeZone: jsii.String("timeZone"),
// the properties below are optional
description: jsii.String("description"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
func NewCfnHoursOfOperation ¶
func NewCfnHoursOfOperation(scope awscdk.Construct, id *string, props *CfnHoursOfOperationProps) CfnHoursOfOperation
Create a new `AWS::Connect::HoursOfOperation`.
type CfnHoursOfOperationProps ¶
type CfnHoursOfOperationProps struct {
// Configuration information for the hours of operation.
Config interface{} `field:"required" json:"config" yaml:"config"`
// The Amazon Resource Name (ARN) for the instance.
InstanceArn *string `field:"required" json:"instanceArn" yaml:"instanceArn"`
// The name for the hours of operation.
Name *string `field:"required" json:"name" yaml:"name"`
// The time zone for the hours of operation.
TimeZone *string `field:"required" json:"timeZone" yaml:"timeZone"`
// The description for the hours of operation.
Description *string `field:"optional" json:"description" yaml:"description"`
// The tags used to organize, track, or control access for this resource.
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnHoursOfOperation`.
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"
cfnHoursOfOperationProps := &cfnHoursOfOperationProps{
config: []interface{}{
&hoursOfOperationConfigProperty{
day: jsii.String("day"),
endTime: &hoursOfOperationTimeSliceProperty{
hours: jsii.Number(123),
minutes: jsii.Number(123),
},
startTime: &hoursOfOperationTimeSliceProperty{
hours: jsii.Number(123),
minutes: jsii.Number(123),
},
},
},
instanceArn: jsii.String("instanceArn"),
name: jsii.String("name"),
timeZone: jsii.String("timeZone"),
// the properties below are optional
description: jsii.String("description"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
type CfnHoursOfOperation_HoursOfOperationConfigProperty ¶
type CfnHoursOfOperation_HoursOfOperationConfigProperty struct {
// The day that the hours of operation applies to.
Day *string `field:"required" json:"day" yaml:"day"`
// The end time that your contact center closes.
EndTime interface{} `field:"required" json:"endTime" yaml:"endTime"`
// The start time that your contact center opens.
StartTime interface{} `field:"required" json:"startTime" yaml:"startTime"`
}
Contains information about the hours of operation.
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"
hoursOfOperationConfigProperty := &hoursOfOperationConfigProperty{
day: jsii.String("day"),
endTime: &hoursOfOperationTimeSliceProperty{
hours: jsii.Number(123),
minutes: jsii.Number(123),
},
startTime: &hoursOfOperationTimeSliceProperty{
hours: jsii.Number(123),
minutes: jsii.Number(123),
},
}
type CfnHoursOfOperation_HoursOfOperationTimeSliceProperty ¶
type CfnHoursOfOperation_HoursOfOperationTimeSliceProperty struct {
// The hours.
Hours *float64 `field:"required" json:"hours" yaml:"hours"`
// The minutes.
Minutes *float64 `field:"required" json:"minutes" yaml:"minutes"`
}
The start time or end time for an hours of operation.
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"
hoursOfOperationTimeSliceProperty := &hoursOfOperationTimeSliceProperty{
hours: jsii.Number(123),
minutes: jsii.Number(123),
}
type CfnPhoneNumber ¶
type CfnPhoneNumber interface {
awscdk.CfnResource
awscdk.IInspectable
// The phone number, in E.164 format.
AttrAddress() *string
// The Amazon Resource Name (ARN) of the phone number.
AttrPhoneNumberArn() *string
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *string
// The ISO country code.
CountryCode() *string
SetCountryCode(val *string)
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
// Experimental.
CreationStack() *[]*string
// The description of the phone number.
Description() *string
SetDescription(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
// Experimental.
LogicalId() *string
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// The prefix of the phone number. If provided, it must contain `+` as part of the country code.
//
// *Pattern* : `^\\+[0-9]{1,15}`.
Prefix() *string
SetPrefix(val *string)
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// The tags used to organize, track, or control access for this resource.
Tags() awscdk.TagManager
// The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
TargetArn() *string
SetTargetArn(val *string)
// The type of phone number.
Type() *string
SetType(val *string)
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
// Experimental.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
// Experimental.
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Connect::PhoneNumber`.
Claims a phone number to the specified Amazon Connect instance.
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"
cfnPhoneNumber := awscdk.Aws_connect.NewCfnPhoneNumber(this, jsii.String("MyCfnPhoneNumber"), &cfnPhoneNumberProps{
countryCode: jsii.String("countryCode"),
targetArn: jsii.String("targetArn"),
type: jsii.String("type"),
// the properties below are optional
description: jsii.String("description"),
prefix: jsii.String("prefix"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
func NewCfnPhoneNumber ¶
func NewCfnPhoneNumber(scope awscdk.Construct, id *string, props *CfnPhoneNumberProps) CfnPhoneNumber
Create a new `AWS::Connect::PhoneNumber`.
type CfnPhoneNumberProps ¶
type CfnPhoneNumberProps struct {
// The ISO country code.
CountryCode *string `field:"required" json:"countryCode" yaml:"countryCode"`
// The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
TargetArn *string `field:"required" json:"targetArn" yaml:"targetArn"`
// The type of phone number.
Type *string `field:"required" json:"type" yaml:"type"`
// The description of the phone number.
Description *string `field:"optional" json:"description" yaml:"description"`
// The prefix of the phone number. If provided, it must contain `+` as part of the country code.
//
// *Pattern* : `^\\+[0-9]{1,15}`.
Prefix *string `field:"optional" json:"prefix" yaml:"prefix"`
// The tags used to organize, track, or control access for this resource.
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnPhoneNumber`.
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"
cfnPhoneNumberProps := &cfnPhoneNumberProps{
countryCode: jsii.String("countryCode"),
targetArn: jsii.String("targetArn"),
type: jsii.String("type"),
// the properties below are optional
description: jsii.String("description"),
prefix: jsii.String("prefix"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
type CfnQuickConnect ¶
type CfnQuickConnect interface {
awscdk.CfnResource
awscdk.IInspectable
// The Amazon Resource Name (ARN) of the quick connect.
AttrQuickConnectArn() *string
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
// Experimental.
CreationStack() *[]*string
// The description of the quick connect.
Description() *string
SetDescription(val *string)
// The Amazon Resource Name (ARN) of the instance.
InstanceArn() *string
SetInstanceArn(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
// Experimental.
LogicalId() *string
// The name of the quick connect.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// Contains information about the quick connect.
QuickConnectConfig() interface{}
SetQuickConnectConfig(val interface{})
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// The tags used to organize, track, or control access for this resource.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
// Experimental.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
// Experimental.
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Connect::QuickConnect`.
The `AWS::Connect::QuickConnnect` resource specifies a quick connect for the specified Amazon Connect instance.
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"
cfnQuickConnect := awscdk.Aws_connect.NewCfnQuickConnect(this, jsii.String("MyCfnQuickConnect"), &cfnQuickConnectProps{
instanceArn: jsii.String("instanceArn"),
name: jsii.String("name"),
quickConnectConfig: &quickConnectConfigProperty{
quickConnectType: jsii.String("quickConnectType"),
// the properties below are optional
phoneConfig: &phoneNumberQuickConnectConfigProperty{
phoneNumber: jsii.String("phoneNumber"),
},
queueConfig: &queueQuickConnectConfigProperty{
contactFlowArn: jsii.String("contactFlowArn"),
queueArn: jsii.String("queueArn"),
},
userConfig: &userQuickConnectConfigProperty{
contactFlowArn: jsii.String("contactFlowArn"),
userArn: jsii.String("userArn"),
},
},
// the properties below are optional
description: jsii.String("description"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
func NewCfnQuickConnect ¶
func NewCfnQuickConnect(scope awscdk.Construct, id *string, props *CfnQuickConnectProps) CfnQuickConnect
Create a new `AWS::Connect::QuickConnect`.
type CfnQuickConnectProps ¶
type CfnQuickConnectProps struct {
// The Amazon Resource Name (ARN) of the instance.
InstanceArn *string `field:"required" json:"instanceArn" yaml:"instanceArn"`
// The name of the quick connect.
Name *string `field:"required" json:"name" yaml:"name"`
// Contains information about the quick connect.
QuickConnectConfig interface{} `field:"required" json:"quickConnectConfig" yaml:"quickConnectConfig"`
// The description of the quick connect.
Description *string `field:"optional" json:"description" yaml:"description"`
// The tags used to organize, track, or control access for this resource.
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnQuickConnect`.
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"
cfnQuickConnectProps := &cfnQuickConnectProps{
instanceArn: jsii.String("instanceArn"),
name: jsii.String("name"),
quickConnectConfig: &quickConnectConfigProperty{
quickConnectType: jsii.String("quickConnectType"),
// the properties below are optional
phoneConfig: &phoneNumberQuickConnectConfigProperty{
phoneNumber: jsii.String("phoneNumber"),
},
queueConfig: &queueQuickConnectConfigProperty{
contactFlowArn: jsii.String("contactFlowArn"),
queueArn: jsii.String("queueArn"),
},
userConfig: &userQuickConnectConfigProperty{
contactFlowArn: jsii.String("contactFlowArn"),
userArn: jsii.String("userArn"),
},
},
// the properties below are optional
description: jsii.String("description"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
type CfnQuickConnect_PhoneNumberQuickConnectConfigProperty ¶
type CfnQuickConnect_PhoneNumberQuickConnectConfigProperty struct {
// The phone number in E.164 format.
PhoneNumber *string `field:"required" json:"phoneNumber" yaml:"phoneNumber"`
}
Contains information about a phone number for a quick connect.
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"
phoneNumberQuickConnectConfigProperty := &phoneNumberQuickConnectConfigProperty{
phoneNumber: jsii.String("phoneNumber"),
}
type CfnQuickConnect_QueueQuickConnectConfigProperty ¶
type CfnQuickConnect_QueueQuickConnectConfigProperty struct {
// The Amazon Resource Name (ARN) of the contact flow.
ContactFlowArn *string `field:"required" json:"contactFlowArn" yaml:"contactFlowArn"`
// The Amazon Resource Name (ARN) of the queue.
QueueArn *string `field:"required" json:"queueArn" yaml:"queueArn"`
}
Contains information about a queue for a quick connect.
The contact flow must be of type Transfer to Queue.
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"
queueQuickConnectConfigProperty := &queueQuickConnectConfigProperty{
contactFlowArn: jsii.String("contactFlowArn"),
queueArn: jsii.String("queueArn"),
}
type CfnQuickConnect_QuickConnectConfigProperty ¶
type CfnQuickConnect_QuickConnectConfigProperty struct {
// The type of quick connect.
//
// In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
QuickConnectType *string `field:"required" json:"quickConnectType" yaml:"quickConnectType"`
// The phone configuration.
//
// This is required only if QuickConnectType is PHONE_NUMBER.
PhoneConfig interface{} `field:"optional" json:"phoneConfig" yaml:"phoneConfig"`
// The queue configuration.
//
// This is required only if QuickConnectType is QUEUE.
QueueConfig interface{} `field:"optional" json:"queueConfig" yaml:"queueConfig"`
// The user configuration.
//
// This is required only if QuickConnectType is USER.
UserConfig interface{} `field:"optional" json:"userConfig" yaml:"userConfig"`
}
Contains configuration settings for a quick connect.
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"
quickConnectConfigProperty := &quickConnectConfigProperty{
quickConnectType: jsii.String("quickConnectType"),
// the properties below are optional
phoneConfig: &phoneNumberQuickConnectConfigProperty{
phoneNumber: jsii.String("phoneNumber"),
},
queueConfig: &queueQuickConnectConfigProperty{
contactFlowArn: jsii.String("contactFlowArn"),
queueArn: jsii.String("queueArn"),
},
userConfig: &userQuickConnectConfigProperty{
contactFlowArn: jsii.String("contactFlowArn"),
userArn: jsii.String("userArn"),
},
}
type CfnQuickConnect_UserQuickConnectConfigProperty ¶
type CfnQuickConnect_UserQuickConnectConfigProperty struct {
// The Amazon Resource Name (ARN) of the contact flow.
ContactFlowArn *string `field:"required" json:"contactFlowArn" yaml:"contactFlowArn"`
// The Amazon Resource Name (ARN) of the user.
UserArn *string `field:"required" json:"userArn" yaml:"userArn"`
}
Contains information about the quick connect configuration settings for a user.
The contact flow must be of type Transfer to Agent.
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"
userQuickConnectConfigProperty := &userQuickConnectConfigProperty{
contactFlowArn: jsii.String("contactFlowArn"),
userArn: jsii.String("userArn"),
}
type CfnTaskTemplate ¶
type CfnTaskTemplate interface {
awscdk.CfnResource
awscdk.IInspectable
AttrArn() *string
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *string
// `AWS::Connect::TaskTemplate.ClientToken`.
ClientToken() *string
SetClientToken(val *string)
// `AWS::Connect::TaskTemplate.Constraints`.
Constraints() interface{}
SetConstraints(val interface{})
// `AWS::Connect::TaskTemplate.ContactFlowArn`.
ContactFlowArn() *string
SetContactFlowArn(val *string)
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
// Experimental.
CreationStack() *[]*string
// `AWS::Connect::TaskTemplate.Defaults`.
Defaults() interface{}
SetDefaults(val interface{})
// `AWS::Connect::TaskTemplate.Description`.
Description() *string
SetDescription(val *string)
// `AWS::Connect::TaskTemplate.Fields`.
Fields() interface{}
SetFields(val interface{})
// `AWS::Connect::TaskTemplate.InstanceArn`.
InstanceArn() *string
SetInstanceArn(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
// Experimental.
LogicalId() *string
// `AWS::Connect::TaskTemplate.Name`.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// `AWS::Connect::TaskTemplate.Status`.
Status() *string
SetStatus(val *string)
// `AWS::Connect::TaskTemplate.Tags`.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
// Experimental.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
// Experimental.
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Connect::TaskTemplate`.
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"
var constraints interface{}
cfnTaskTemplate := awscdk.Aws_connect.NewCfnTaskTemplate(this, jsii.String("MyCfnTaskTemplate"), &cfnTaskTemplateProps{
instanceArn: jsii.String("instanceArn"),
// the properties below are optional
clientToken: jsii.String("clientToken"),
constraints: constraints,
contactFlowArn: jsii.String("contactFlowArn"),
defaults: []interface{}{
&defaultFieldValueProperty{
defaultValue: jsii.String("defaultValue"),
id: &fieldIdentifierProperty{
name: jsii.String("name"),
},
},
},
description: jsii.String("description"),
fields: []interface{}{
&fieldProperty{
id: &fieldIdentifierProperty{
name: jsii.String("name"),
},
type: jsii.String("type"),
// the properties below are optional
description: jsii.String("description"),
singleSelectOptions: []*string{
jsii.String("singleSelectOptions"),
},
},
},
name: jsii.String("name"),
status: jsii.String("status"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
func NewCfnTaskTemplate ¶
func NewCfnTaskTemplate(scope awscdk.Construct, id *string, props *CfnTaskTemplateProps) CfnTaskTemplate
Create a new `AWS::Connect::TaskTemplate`.
type CfnTaskTemplateProps ¶
type CfnTaskTemplateProps struct {
// `AWS::Connect::TaskTemplate.InstanceArn`.
InstanceArn *string `field:"required" json:"instanceArn" yaml:"instanceArn"`
// `AWS::Connect::TaskTemplate.ClientToken`.
ClientToken *string `field:"optional" json:"clientToken" yaml:"clientToken"`
// `AWS::Connect::TaskTemplate.Constraints`.
Constraints interface{} `field:"optional" json:"constraints" yaml:"constraints"`
// `AWS::Connect::TaskTemplate.ContactFlowArn`.
ContactFlowArn *string `field:"optional" json:"contactFlowArn" yaml:"contactFlowArn"`
// `AWS::Connect::TaskTemplate.Defaults`.
Defaults interface{} `field:"optional" json:"defaults" yaml:"defaults"`
// `AWS::Connect::TaskTemplate.Description`.
Description *string `field:"optional" json:"description" yaml:"description"`
// `AWS::Connect::TaskTemplate.Fields`.
Fields interface{} `field:"optional" json:"fields" yaml:"fields"`
// `AWS::Connect::TaskTemplate.Name`.
Name *string `field:"optional" json:"name" yaml:"name"`
// `AWS::Connect::TaskTemplate.Status`.
Status *string `field:"optional" json:"status" yaml:"status"`
// `AWS::Connect::TaskTemplate.Tags`.
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnTaskTemplate`.
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"
var constraints interface{}
cfnTaskTemplateProps := &cfnTaskTemplateProps{
instanceArn: jsii.String("instanceArn"),
// the properties below are optional
clientToken: jsii.String("clientToken"),
constraints: constraints,
contactFlowArn: jsii.String("contactFlowArn"),
defaults: []interface{}{
&defaultFieldValueProperty{
defaultValue: jsii.String("defaultValue"),
id: &fieldIdentifierProperty{
name: jsii.String("name"),
},
},
},
description: jsii.String("description"),
fields: []interface{}{
&fieldProperty{
id: &fieldIdentifierProperty{
name: jsii.String("name"),
},
type: jsii.String("type"),
// the properties below are optional
description: jsii.String("description"),
singleSelectOptions: []*string{
jsii.String("singleSelectOptions"),
},
},
},
name: jsii.String("name"),
status: jsii.String("status"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
type CfnTaskTemplate_DefaultFieldValueProperty ¶
type CfnTaskTemplate_DefaultFieldValueProperty struct {
// `CfnTaskTemplate.DefaultFieldValueProperty.DefaultValue`.
DefaultValue *string `field:"required" json:"defaultValue" yaml:"defaultValue"`
// `CfnTaskTemplate.DefaultFieldValueProperty.Id`.
Id interface{} `field:"required" json:"id" yaml:"id"`
}
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"
defaultFieldValueProperty := &defaultFieldValueProperty{
defaultValue: jsii.String("defaultValue"),
id: &fieldIdentifierProperty{
name: jsii.String("name"),
},
}
type CfnTaskTemplate_FieldIdentifierProperty ¶
type CfnTaskTemplate_FieldIdentifierProperty struct {
// `CfnTaskTemplate.FieldIdentifierProperty.Name`.
Name *string `field:"required" json:"name" yaml:"name"`
}
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"
fieldIdentifierProperty := &fieldIdentifierProperty{
name: jsii.String("name"),
}
type CfnTaskTemplate_FieldProperty ¶
type CfnTaskTemplate_FieldProperty struct {
// `CfnTaskTemplate.FieldProperty.Id`.
Id interface{} `field:"required" json:"id" yaml:"id"`
// `CfnTaskTemplate.FieldProperty.Type`.
Type *string `field:"required" json:"type" yaml:"type"`
// `CfnTaskTemplate.FieldProperty.Description`.
Description *string `field:"optional" json:"description" yaml:"description"`
// `CfnTaskTemplate.FieldProperty.SingleSelectOptions`.
SingleSelectOptions *[]*string `field:"optional" json:"singleSelectOptions" yaml:"singleSelectOptions"`
}
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"
fieldProperty := &fieldProperty{
id: &fieldIdentifierProperty{
name: jsii.String("name"),
},
type: jsii.String("type"),
// the properties below are optional
description: jsii.String("description"),
singleSelectOptions: []*string{
jsii.String("singleSelectOptions"),
},
}
type CfnUser ¶
type CfnUser interface {
awscdk.CfnResource
awscdk.IInspectable
// The Amazon Resource Name (ARN) of the user.
AttrUserArn() *string
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
// Experimental.
CreationStack() *[]*string
// The identifier of the user account in the directory used for identity management.
DirectoryUserId() *string
SetDirectoryUserId(val *string)
// The Amazon Resource Name (ARN) of the user's hierarchy group.
HierarchyGroupArn() *string
SetHierarchyGroupArn(val *string)
// Information about the user identity.
IdentityInfo() interface{}
SetIdentityInfo(val interface{})
// The Amazon Resource Name (ARN) of the instance.
InstanceArn() *string
SetInstanceArn(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
// Experimental.
LogicalId() *string
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// The user's password.
Password() *string
SetPassword(val *string)
// Information about the phone configuration for the user.
PhoneConfig() interface{}
SetPhoneConfig(val interface{})
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
// Experimental.
Ref() *string
// The Amazon Resource Name (ARN) of the user's routing profile.
RoutingProfileArn() *string
SetRoutingProfileArn(val *string)
// The Amazon Resource Name (ARN) of the user's security profile.
SecurityProfileArns() *[]*string
SetSecurityProfileArns(val *[]*string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// The tags.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// The user name assigned to the user account.
Username() *string
SetUsername(val *string)
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
// Experimental.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
// Experimental.
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Connect::User`.
Creates a user account for the specified Amazon Connect instance.
For information about how to create user accounts using the Amazon Connect console, see [Add Users](https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html) in the *Amazon Connect Administrator Guide* .
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"
cfnUser := awscdk.Aws_connect.NewCfnUser(this, jsii.String("MyCfnUser"), &cfnUserProps{
instanceArn: jsii.String("instanceArn"),
phoneConfig: &userPhoneConfigProperty{
phoneType: jsii.String("phoneType"),
// the properties below are optional
afterContactWorkTimeLimit: jsii.Number(123),
autoAccept: jsii.Boolean(false),
deskPhoneNumber: jsii.String("deskPhoneNumber"),
},
routingProfileArn: jsii.String("routingProfileArn"),
securityProfileArns: []*string{
jsii.String("securityProfileArns"),
},
username: jsii.String("username"),
// the properties below are optional
directoryUserId: jsii.String("directoryUserId"),
hierarchyGroupArn: jsii.String("hierarchyGroupArn"),
identityInfo: &userIdentityInfoProperty{
email: jsii.String("email"),
firstName: jsii.String("firstName"),
lastName: jsii.String("lastName"),
},
password: jsii.String("password"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
func NewCfnUser ¶
func NewCfnUser(scope awscdk.Construct, id *string, props *CfnUserProps) CfnUser
Create a new `AWS::Connect::User`.
type CfnUserHierarchyGroup ¶
type CfnUserHierarchyGroup interface {
awscdk.CfnResource
awscdk.IInspectable
// The Amazon Resource Name (ARN) for the user hierarchy group.
AttrUserHierarchyGroupArn() *string
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
// Experimental.
CreationStack() *[]*string
// The Amazon Resource Name (ARN) of the user hierarchy group.
InstanceArn() *string
SetInstanceArn(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
// Experimental.
LogicalId() *string
// The name of the user hierarchy group.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// The Amazon Resource Name (ARN) of the parent group.
ParentGroupArn() *string
SetParentGroupArn(val *string)
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
// Experimental.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
// Experimental.
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Connect::UserHierarchyGroup`.
Creates a new user hierarchy group.
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"
cfnUserHierarchyGroup := awscdk.Aws_connect.NewCfnUserHierarchyGroup(this, jsii.String("MyCfnUserHierarchyGroup"), &cfnUserHierarchyGroupProps{
instanceArn: jsii.String("instanceArn"),
name: jsii.String("name"),
// the properties below are optional
parentGroupArn: jsii.String("parentGroupArn"),
})
func NewCfnUserHierarchyGroup ¶
func NewCfnUserHierarchyGroup(scope awscdk.Construct, id *string, props *CfnUserHierarchyGroupProps) CfnUserHierarchyGroup
Create a new `AWS::Connect::UserHierarchyGroup`.
type CfnUserHierarchyGroupProps ¶
type CfnUserHierarchyGroupProps struct {
// The Amazon Resource Name (ARN) of the user hierarchy group.
InstanceArn *string `field:"required" json:"instanceArn" yaml:"instanceArn"`
// The name of the user hierarchy group.
Name *string `field:"required" json:"name" yaml:"name"`
// The Amazon Resource Name (ARN) of the parent group.
ParentGroupArn *string `field:"optional" json:"parentGroupArn" yaml:"parentGroupArn"`
}
Properties for defining a `CfnUserHierarchyGroup`.
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"
cfnUserHierarchyGroupProps := &cfnUserHierarchyGroupProps{
instanceArn: jsii.String("instanceArn"),
name: jsii.String("name"),
// the properties below are optional
parentGroupArn: jsii.String("parentGroupArn"),
}
type CfnUserProps ¶
type CfnUserProps struct {
// The Amazon Resource Name (ARN) of the instance.
InstanceArn *string `field:"required" json:"instanceArn" yaml:"instanceArn"`
// Information about the phone configuration for the user.
PhoneConfig interface{} `field:"required" json:"phoneConfig" yaml:"phoneConfig"`
// The Amazon Resource Name (ARN) of the user's routing profile.
RoutingProfileArn *string `field:"required" json:"routingProfileArn" yaml:"routingProfileArn"`
// The Amazon Resource Name (ARN) of the user's security profile.
SecurityProfileArns *[]*string `field:"required" json:"securityProfileArns" yaml:"securityProfileArns"`
// The user name assigned to the user account.
Username *string `field:"required" json:"username" yaml:"username"`
// The identifier of the user account in the directory used for identity management.
DirectoryUserId *string `field:"optional" json:"directoryUserId" yaml:"directoryUserId"`
// The Amazon Resource Name (ARN) of the user's hierarchy group.
HierarchyGroupArn *string `field:"optional" json:"hierarchyGroupArn" yaml:"hierarchyGroupArn"`
// Information about the user identity.
IdentityInfo interface{} `field:"optional" json:"identityInfo" yaml:"identityInfo"`
// The user's password.
Password *string `field:"optional" json:"password" yaml:"password"`
// The tags.
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnUser`.
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"
cfnUserProps := &cfnUserProps{
instanceArn: jsii.String("instanceArn"),
phoneConfig: &userPhoneConfigProperty{
phoneType: jsii.String("phoneType"),
// the properties below are optional
afterContactWorkTimeLimit: jsii.Number(123),
autoAccept: jsii.Boolean(false),
deskPhoneNumber: jsii.String("deskPhoneNumber"),
},
routingProfileArn: jsii.String("routingProfileArn"),
securityProfileArns: []*string{
jsii.String("securityProfileArns"),
},
username: jsii.String("username"),
// the properties below are optional
directoryUserId: jsii.String("directoryUserId"),
hierarchyGroupArn: jsii.String("hierarchyGroupArn"),
identityInfo: &userIdentityInfoProperty{
email: jsii.String("email"),
firstName: jsii.String("firstName"),
lastName: jsii.String("lastName"),
},
password: jsii.String("password"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
type CfnUser_UserIdentityInfoProperty ¶
type CfnUser_UserIdentityInfoProperty struct {
// The email address.
//
// If you are using SAML for identity management and include this parameter, an error is returned.
Email *string `field:"optional" json:"email" yaml:"email"`
// The first name.
//
// This is required if you are using Amazon Connect or SAML for identity management.
FirstName *string `field:"optional" json:"firstName" yaml:"firstName"`
// The last name.
//
// This is required if you are using Amazon Connect or SAML for identity management.
LastName *string `field:"optional" json:"lastName" yaml:"lastName"`
}
Contains information about the identity of a user.
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"
userIdentityInfoProperty := &userIdentityInfoProperty{
email: jsii.String("email"),
firstName: jsii.String("firstName"),
lastName: jsii.String("lastName"),
}
type CfnUser_UserPhoneConfigProperty ¶
type CfnUser_UserPhoneConfigProperty struct {
// The phone type.
PhoneType *string `field:"required" json:"phoneType" yaml:"phoneType"`
// The After Call Work (ACW) timeout setting, in seconds.
AfterContactWorkTimeLimit *float64 `field:"optional" json:"afterContactWorkTimeLimit" yaml:"afterContactWorkTimeLimit"`
// The Auto accept setting.
AutoAccept interface{} `field:"optional" json:"autoAccept" yaml:"autoAccept"`
// The phone number for the user's desk phone.
DeskPhoneNumber *string `field:"optional" json:"deskPhoneNumber" yaml:"deskPhoneNumber"`
}
Contains information about the phone configuration settings for a user.
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"
userPhoneConfigProperty := &userPhoneConfigProperty{
phoneType: jsii.String("phoneType"),
// the properties below are optional
afterContactWorkTimeLimit: jsii.Number(123),
autoAccept: jsii.Boolean(false),
deskPhoneNumber: jsii.String("deskPhoneNumber"),
}