Documentation ¶
Index ¶
- func CfnApprovedOrigin_CFN_RESOURCE_TYPE_NAME() *string
- func CfnApprovedOrigin_IsCfnElement(x interface{}) *bool
- func CfnApprovedOrigin_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnApprovedOrigin_IsConstruct(x interface{}) *bool
- 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 CfnInstanceStorageConfig_CFN_RESOURCE_TYPE_NAME() *string
- func CfnInstanceStorageConfig_IsCfnElement(x interface{}) *bool
- func CfnInstanceStorageConfig_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnInstanceStorageConfig_IsConstruct(x interface{}) *bool
- func CfnInstance_CFN_RESOURCE_TYPE_NAME() *string
- func CfnInstance_IsCfnElement(x interface{}) *bool
- func CfnInstance_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnInstance_IsConstruct(x interface{}) *bool
- func CfnIntegrationAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnIntegrationAssociation_IsCfnElement(x interface{}) *bool
- func CfnIntegrationAssociation_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnIntegrationAssociation_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 CfnRule_CFN_RESOURCE_TYPE_NAME() *string
- func CfnRule_IsCfnElement(x interface{}) *bool
- func CfnRule_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnRule_IsConstruct(x interface{}) *bool
- func CfnSecurityKey_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSecurityKey_IsCfnElement(x interface{}) *bool
- func CfnSecurityKey_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnSecurityKey_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 NewCfnApprovedOrigin_Override(c CfnApprovedOrigin, scope constructs.Construct, id *string, ...)
- func NewCfnContactFlowModule_Override(c CfnContactFlowModule, scope constructs.Construct, id *string, ...)
- func NewCfnContactFlow_Override(c CfnContactFlow, scope constructs.Construct, id *string, ...)
- func NewCfnHoursOfOperation_Override(c CfnHoursOfOperation, scope constructs.Construct, id *string, ...)
- func NewCfnInstanceStorageConfig_Override(c CfnInstanceStorageConfig, scope constructs.Construct, id *string, ...)
- func NewCfnInstance_Override(c CfnInstance, scope constructs.Construct, id *string, props *CfnInstanceProps)
- func NewCfnIntegrationAssociation_Override(c CfnIntegrationAssociation, scope constructs.Construct, id *string, ...)
- func NewCfnPhoneNumber_Override(c CfnPhoneNumber, scope constructs.Construct, id *string, ...)
- func NewCfnQuickConnect_Override(c CfnQuickConnect, scope constructs.Construct, id *string, ...)
- func NewCfnRule_Override(c CfnRule, scope constructs.Construct, id *string, props *CfnRuleProps)
- func NewCfnSecurityKey_Override(c CfnSecurityKey, scope constructs.Construct, id *string, ...)
- func NewCfnTaskTemplate_Override(c CfnTaskTemplate, scope constructs.Construct, id *string, ...)
- func NewCfnUserHierarchyGroup_Override(c CfnUserHierarchyGroup, scope constructs.Construct, id *string, ...)
- func NewCfnUser_Override(c CfnUser, scope constructs.Construct, id *string, props *CfnUserProps)
- type CfnApprovedOrigin
- type CfnApprovedOriginProps
- type CfnContactFlow
- type CfnContactFlowModule
- type CfnContactFlowModuleProps
- type CfnContactFlowProps
- type CfnHoursOfOperation
- type CfnHoursOfOperationProps
- type CfnHoursOfOperation_HoursOfOperationConfigProperty
- type CfnHoursOfOperation_HoursOfOperationTimeSliceProperty
- type CfnInstance
- type CfnInstanceProps
- type CfnInstanceStorageConfig
- type CfnInstanceStorageConfigProps
- type CfnInstanceStorageConfig_EncryptionConfigProperty
- type CfnInstanceStorageConfig_KinesisFirehoseConfigProperty
- type CfnInstanceStorageConfig_KinesisStreamConfigProperty
- type CfnInstanceStorageConfig_KinesisVideoStreamConfigProperty
- type CfnInstanceStorageConfig_S3ConfigProperty
- type CfnInstance_AttributesProperty
- type CfnIntegrationAssociation
- type CfnIntegrationAssociationProps
- type CfnPhoneNumber
- type CfnPhoneNumberProps
- type CfnQuickConnect
- type CfnQuickConnectProps
- type CfnQuickConnect_PhoneNumberQuickConnectConfigProperty
- type CfnQuickConnect_QueueQuickConnectConfigProperty
- type CfnQuickConnect_QuickConnectConfigProperty
- type CfnQuickConnect_UserQuickConnectConfigProperty
- type CfnRule
- type CfnRuleProps
- type CfnRule_ActionsProperty
- type CfnRule_EventBridgeActionProperty
- type CfnRule_NotificationRecipientTypeProperty
- type CfnRule_ReferenceProperty
- type CfnRule_RuleTriggerEventSourceProperty
- type CfnRule_SendNotificationActionProperty
- type CfnRule_TaskActionProperty
- type CfnSecurityKey
- type CfnSecurityKeyProps
- type CfnTaskTemplate
- type CfnTaskTemplateProps
- type CfnTaskTemplate_ConstraintsProperty
- type CfnTaskTemplate_DefaultFieldValueProperty
- type CfnTaskTemplate_FieldIdentifierProperty
- type CfnTaskTemplate_FieldProperty
- type CfnTaskTemplate_InvisibleFieldInfoProperty
- type CfnTaskTemplate_ReadOnlyFieldInfoProperty
- type CfnTaskTemplate_RequiredFieldInfoProperty
- 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 CfnApprovedOrigin_CFN_RESOURCE_TYPE_NAME ¶ added in v2.63.0
func CfnApprovedOrigin_CFN_RESOURCE_TYPE_NAME() *string
func CfnApprovedOrigin_IsCfnElement ¶ added in v2.63.0
func CfnApprovedOrigin_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnApprovedOrigin_IsCfnResource ¶ added in v2.63.0
func CfnApprovedOrigin_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnApprovedOrigin_IsConstruct ¶ added in v2.63.0
func CfnApprovedOrigin_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnContactFlowModule_CFN_RESOURCE_TYPE_NAME ¶ added in v2.2.0
func CfnContactFlowModule_CFN_RESOURCE_TYPE_NAME() *string
func CfnContactFlowModule_IsCfnElement ¶ added in v2.2.0
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.
func CfnContactFlowModule_IsCfnResource ¶ added in v2.2.0
func CfnContactFlowModule_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnContactFlowModule_IsConstruct ¶ added in v2.2.0
func CfnContactFlowModule_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnContactFlow_CFN_RESOURCE_TYPE_NAME ¶ added in v2.2.0
func CfnContactFlow_CFN_RESOURCE_TYPE_NAME() *string
func CfnContactFlow_IsCfnElement ¶ added in v2.2.0
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.
func CfnContactFlow_IsCfnResource ¶ added in v2.2.0
func CfnContactFlow_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnContactFlow_IsConstruct ¶ added in v2.2.0
func CfnContactFlow_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func 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.
func CfnHoursOfOperation_IsCfnResource ¶
func CfnHoursOfOperation_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnHoursOfOperation_IsConstruct ¶
func CfnHoursOfOperation_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnInstanceStorageConfig_CFN_RESOURCE_TYPE_NAME ¶ added in v2.42.0
func CfnInstanceStorageConfig_CFN_RESOURCE_TYPE_NAME() *string
func CfnInstanceStorageConfig_IsCfnElement ¶ added in v2.42.0
func CfnInstanceStorageConfig_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnInstanceStorageConfig_IsCfnResource ¶ added in v2.42.0
func CfnInstanceStorageConfig_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnInstanceStorageConfig_IsConstruct ¶ added in v2.42.0
func CfnInstanceStorageConfig_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnInstance_CFN_RESOURCE_TYPE_NAME ¶ added in v2.42.0
func CfnInstance_CFN_RESOURCE_TYPE_NAME() *string
func CfnInstance_IsCfnElement ¶ added in v2.42.0
func CfnInstance_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnInstance_IsCfnResource ¶ added in v2.42.0
func CfnInstance_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnInstance_IsConstruct ¶ added in v2.42.0
func CfnInstance_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnIntegrationAssociation_CFN_RESOURCE_TYPE_NAME ¶ added in v2.63.0
func CfnIntegrationAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnIntegrationAssociation_IsCfnElement ¶ added in v2.63.0
func CfnIntegrationAssociation_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnIntegrationAssociation_IsCfnResource ¶ added in v2.63.0
func CfnIntegrationAssociation_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnIntegrationAssociation_IsConstruct ¶ added in v2.63.0
func CfnIntegrationAssociation_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnPhoneNumber_CFN_RESOURCE_TYPE_NAME ¶ added in v2.23.0
func CfnPhoneNumber_CFN_RESOURCE_TYPE_NAME() *string
func CfnPhoneNumber_IsCfnElement ¶ added in v2.23.0
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.
func CfnPhoneNumber_IsCfnResource ¶ added in v2.23.0
func CfnPhoneNumber_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnPhoneNumber_IsConstruct ¶ added in v2.23.0
func CfnPhoneNumber_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func 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.
func CfnQuickConnect_IsCfnResource ¶
func CfnQuickConnect_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnQuickConnect_IsConstruct ¶
func CfnQuickConnect_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnRule_CFN_RESOURCE_TYPE_NAME ¶ added in v2.55.0
func CfnRule_CFN_RESOURCE_TYPE_NAME() *string
func CfnRule_IsCfnElement ¶ added in v2.55.0
func CfnRule_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnRule_IsCfnResource ¶ added in v2.55.0
func CfnRule_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnRule_IsConstruct ¶ added in v2.55.0
func CfnRule_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnSecurityKey_CFN_RESOURCE_TYPE_NAME ¶ added in v2.63.0
func CfnSecurityKey_CFN_RESOURCE_TYPE_NAME() *string
func CfnSecurityKey_IsCfnElement ¶ added in v2.63.0
func CfnSecurityKey_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnSecurityKey_IsCfnResource ¶ added in v2.63.0
func CfnSecurityKey_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnSecurityKey_IsConstruct ¶ added in v2.63.0
func CfnSecurityKey_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnTaskTemplate_CFN_RESOURCE_TYPE_NAME ¶ added in v2.29.0
func CfnTaskTemplate_CFN_RESOURCE_TYPE_NAME() *string
func CfnTaskTemplate_IsCfnElement ¶ added in v2.29.0
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.
func CfnTaskTemplate_IsCfnResource ¶ added in v2.29.0
func CfnTaskTemplate_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnTaskTemplate_IsConstruct ¶ added in v2.29.0
func CfnTaskTemplate_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func 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.
func CfnUserHierarchyGroup_IsCfnResource ¶
func CfnUserHierarchyGroup_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnUserHierarchyGroup_IsConstruct ¶
func CfnUserHierarchyGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func 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.
func CfnUser_IsCfnResource ¶
func CfnUser_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnUser_IsConstruct ¶
func CfnUser_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnApprovedOrigin_Override ¶ added in v2.63.0
func NewCfnApprovedOrigin_Override(c CfnApprovedOrigin, scope constructs.Construct, id *string, props *CfnApprovedOriginProps)
Create a new `AWS::Connect::ApprovedOrigin`.
func NewCfnContactFlowModule_Override ¶ added in v2.2.0
func NewCfnContactFlowModule_Override(c CfnContactFlowModule, scope constructs.Construct, id *string, props *CfnContactFlowModuleProps)
Create a new `AWS::Connect::ContactFlowModule`.
func NewCfnContactFlow_Override ¶ added in v2.2.0
func NewCfnContactFlow_Override(c CfnContactFlow, scope constructs.Construct, id *string, props *CfnContactFlowProps)
Create a new `AWS::Connect::ContactFlow`.
func NewCfnHoursOfOperation_Override ¶
func NewCfnHoursOfOperation_Override(c CfnHoursOfOperation, scope constructs.Construct, id *string, props *CfnHoursOfOperationProps)
Create a new `AWS::Connect::HoursOfOperation`.
func NewCfnInstanceStorageConfig_Override ¶ added in v2.42.0
func NewCfnInstanceStorageConfig_Override(c CfnInstanceStorageConfig, scope constructs.Construct, id *string, props *CfnInstanceStorageConfigProps)
Create a new `AWS::Connect::InstanceStorageConfig`.
func NewCfnInstance_Override ¶ added in v2.42.0
func NewCfnInstance_Override(c CfnInstance, scope constructs.Construct, id *string, props *CfnInstanceProps)
Create a new `AWS::Connect::Instance`.
func NewCfnIntegrationAssociation_Override ¶ added in v2.63.0
func NewCfnIntegrationAssociation_Override(c CfnIntegrationAssociation, scope constructs.Construct, id *string, props *CfnIntegrationAssociationProps)
Create a new `AWS::Connect::IntegrationAssociation`.
func NewCfnPhoneNumber_Override ¶ added in v2.23.0
func NewCfnPhoneNumber_Override(c CfnPhoneNumber, scope constructs.Construct, id *string, props *CfnPhoneNumberProps)
Create a new `AWS::Connect::PhoneNumber`.
func NewCfnQuickConnect_Override ¶
func NewCfnQuickConnect_Override(c CfnQuickConnect, scope constructs.Construct, id *string, props *CfnQuickConnectProps)
Create a new `AWS::Connect::QuickConnect`.
func NewCfnRule_Override ¶ added in v2.55.0
func NewCfnRule_Override(c CfnRule, scope constructs.Construct, id *string, props *CfnRuleProps)
Create a new `AWS::Connect::Rule`.
func NewCfnSecurityKey_Override ¶ added in v2.63.0
func NewCfnSecurityKey_Override(c CfnSecurityKey, scope constructs.Construct, id *string, props *CfnSecurityKeyProps)
Create a new `AWS::Connect::SecurityKey`.
func NewCfnTaskTemplate_Override ¶ added in v2.29.0
func NewCfnTaskTemplate_Override(c CfnTaskTemplate, scope constructs.Construct, id *string, props *CfnTaskTemplateProps)
Create a new `AWS::Connect::TaskTemplate`.
func NewCfnUserHierarchyGroup_Override ¶
func NewCfnUserHierarchyGroup_Override(c CfnUserHierarchyGroup, scope constructs.Construct, id *string, props *CfnUserHierarchyGroupProps)
Create a new `AWS::Connect::UserHierarchyGroup`.
func NewCfnUser_Override ¶
func NewCfnUser_Override(c CfnUser, scope constructs.Construct, id *string, props *CfnUserProps)
Create a new `AWS::Connect::User`.
Types ¶
type CfnApprovedOrigin ¶ added in v2.63.0
type CfnApprovedOrigin interface { awscdk.CfnResource awscdk.IInspectable // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // `AWS::Connect::ApprovedOrigin.InstanceId`. InstanceId() *string SetInstanceId(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // `AWS::Connect::ApprovedOrigin.Origin`. Origin() *string SetOrigin(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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::Connect::ApprovedOrigin`.
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" cfnApprovedOrigin := awscdk.Aws_connect.NewCfnApprovedOrigin(this, jsii.String("MyCfnApprovedOrigin"), &cfnApprovedOriginProps{ instanceId: jsii.String("instanceId"), origin: jsii.String("origin"), })
func NewCfnApprovedOrigin ¶ added in v2.63.0
func NewCfnApprovedOrigin(scope constructs.Construct, id *string, props *CfnApprovedOriginProps) CfnApprovedOrigin
Create a new `AWS::Connect::ApprovedOrigin`.
type CfnApprovedOriginProps ¶ added in v2.63.0
type CfnApprovedOriginProps struct { // `AWS::Connect::ApprovedOrigin.InstanceId`. InstanceId *string `field:"required" json:"instanceId" yaml:"instanceId"` // `AWS::Connect::ApprovedOrigin.Origin`. Origin *string `field:"required" json:"origin" yaml:"origin"` }
Properties for defining a `CfnApprovedOrigin`.
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" cfnApprovedOriginProps := &cfnApprovedOriginProps{ instanceId: jsii.String("instanceId"), origin: jsii.String("origin"), }
type CfnContactFlow ¶ added in v2.2.0
type CfnContactFlow interface { awscdk.CfnResource awscdk.IInspectable // `Ref` returns the Amazon Resource Name (ARN) of the flow. For example:. // // `{ "Ref": "myFlowArn" }`. AttrContactFlowArn() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // The content of the flow. // // For more information, see [Amazon Connect Flow language](https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html) in the *Amazon Connect Administrator Guide* . 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. CreationStack() *[]*string // The description of the 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. LogicalId() *string // The name of the flow. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The state of the 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 flow. // // For descriptions of the available types, see [Choose a 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) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::Connect::ContactFlow`.
Specifies a flow for an 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"), type: jsii.String("type"), // 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 NewCfnContactFlow ¶ added in v2.2.0
func NewCfnContactFlow(scope constructs.Construct, id *string, props *CfnContactFlowProps) CfnContactFlow
Create a new `AWS::Connect::ContactFlow`.
type CfnContactFlowModule ¶ added in v2.2.0
type CfnContactFlowModule interface { awscdk.CfnResource awscdk.IInspectable // `Ref` returns the Amazon Resource Name (ARN) of the flow module. For example:. // // `{ "Ref": "myFlowModuleArn" }`. AttrContactFlowModuleArn() *string AttrStatus() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // The content of the 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. CreationStack() *[]*string // The description of the 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. LogicalId() *string // The name of the flow module. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The state of the 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 // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::Connect::ContactFlowModule`.
Specifies a flow module for an 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 ¶ added in v2.2.0
func NewCfnContactFlowModule(scope constructs.Construct, id *string, props *CfnContactFlowModuleProps) CfnContactFlowModule
Create a new `AWS::Connect::ContactFlowModule`.
type CfnContactFlowModuleProps ¶ added in v2.2.0
type CfnContactFlowModuleProps struct { // The content of the 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 flow module. Name *string `field:"required" json:"name" yaml:"name"` // The description of the flow module. Description *string `field:"optional" json:"description" yaml:"description"` // The state of the 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 ¶ added in v2.2.0
type CfnContactFlowProps struct { // The content of the flow. // // For more information, see [Amazon Connect Flow language](https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html) in the *Amazon Connect Administrator Guide* . 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 flow. Name *string `field:"required" json:"name" yaml:"name"` // The type of the flow. // // For descriptions of the available types, see [Choose a 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:"required" json:"type" yaml:"type"` // The description of the flow. Description *string `field:"optional" json:"description" yaml:"description"` // The state of the 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"` }
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"), type: jsii.String("type"), // 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 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. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. 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. 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. LogicalId() *string // The name for the hours of operation. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The tags used to organize, track, or control access for this resource. // // For example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags() awscdk.TagManager // The time zone for the hours of operation. TimeZone() *string SetTimeZone(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::Connect::HoursOfOperation`.
Specifies 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 constructs.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. // // For example, { "tags": {"key1":"value1", "key2":"value2"} }. 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 CfnInstance ¶ added in v2.42.0
type CfnInstance interface { awscdk.CfnResource awscdk.IInspectable // The Amazon Resource Name (ARN) of the instance. AttrArn() *string // When the instance was created. AttrCreatedTime() *string // A toggle for an individual feature at the instance level. Attributes() interface{} SetAttributes(val interface{}) // The identifier of the Amazon Connect instance. // // You can find the instanceId in the ARN of the instance. AttrId() *string // The state of the instance. AttrInstanceStatus() *string // The service role of the instance. AttrServiceRole() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The identifier for the directory. DirectoryId() *string SetDirectoryId(val *string) // The identity management type. IdentityManagementType() *string SetIdentityManagementType(val *string) // The alias of instance. // // `InstanceAlias` is only required when `IdentityManagementType` is `CONNECT_MANAGED` or `SAML` . `InstanceAlias` is not required when `IdentityManagementType` is `EXISTING_DIRECTORY` . InstanceAlias() *string SetInstanceAlias(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::Connect::Instance`.
*This is a preview release for Amazon Connect . It is subject to change.*
Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
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" cfnInstance := awscdk.Aws_connect.NewCfnInstance(this, jsii.String("MyCfnInstance"), &cfnInstanceProps{ attributes: &attributesProperty{ inboundCalls: jsii.Boolean(false), outboundCalls: jsii.Boolean(false), // the properties below are optional autoResolveBestVoices: jsii.Boolean(false), contactflowLogs: jsii.Boolean(false), contactLens: jsii.Boolean(false), earlyMedia: jsii.Boolean(false), useCustomTtsVoices: jsii.Boolean(false), }, identityManagementType: jsii.String("identityManagementType"), // the properties below are optional directoryId: jsii.String("directoryId"), instanceAlias: jsii.String("instanceAlias"), })
func NewCfnInstance ¶ added in v2.42.0
func NewCfnInstance(scope constructs.Construct, id *string, props *CfnInstanceProps) CfnInstance
Create a new `AWS::Connect::Instance`.
type CfnInstanceProps ¶ added in v2.42.0
type CfnInstanceProps struct { // A toggle for an individual feature at the instance level. Attributes interface{} `field:"required" json:"attributes" yaml:"attributes"` // The identity management type. IdentityManagementType *string `field:"required" json:"identityManagementType" yaml:"identityManagementType"` // The identifier for the directory. DirectoryId *string `field:"optional" json:"directoryId" yaml:"directoryId"` // The alias of instance. // // `InstanceAlias` is only required when `IdentityManagementType` is `CONNECT_MANAGED` or `SAML` . `InstanceAlias` is not required when `IdentityManagementType` is `EXISTING_DIRECTORY` . InstanceAlias *string `field:"optional" json:"instanceAlias" yaml:"instanceAlias"` }
Properties for defining a `CfnInstance`.
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" cfnInstanceProps := &cfnInstanceProps{ attributes: &attributesProperty{ inboundCalls: jsii.Boolean(false), outboundCalls: jsii.Boolean(false), // the properties below are optional autoResolveBestVoices: jsii.Boolean(false), contactflowLogs: jsii.Boolean(false), contactLens: jsii.Boolean(false), earlyMedia: jsii.Boolean(false), useCustomTtsVoices: jsii.Boolean(false), }, identityManagementType: jsii.String("identityManagementType"), // the properties below are optional directoryId: jsii.String("directoryId"), instanceAlias: jsii.String("instanceAlias"), }
type CfnInstanceStorageConfig ¶ added in v2.42.0
type CfnInstanceStorageConfig interface { awscdk.CfnResource awscdk.IInspectable // The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID. AttrAssociationId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The Amazon Resource Name (ARN) of the instance. InstanceArn() *string SetInstanceArn(val *string) // The configuration of the Kinesis Firehose delivery stream. KinesisFirehoseConfig() interface{} SetKinesisFirehoseConfig(val interface{}) // The configuration of the Kinesis data stream. KinesisStreamConfig() interface{} SetKinesisStreamConfig(val interface{}) // The configuration of the Kinesis video stream. KinesisVideoStreamConfig() interface{} SetKinesisVideoStreamConfig(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // A valid resource type. // // Following are the valid resource types: `CHAT_TRANSCRIPTS` | `CALL_RECORDINGS` | `SCHEDULED_REPORTS` | `MEDIA_STREAMS` | `CONTACT_TRACE_RECORDS` | `AGENT_EVENTS`. ResourceType() *string SetResourceType(val *string) // The S3 bucket configuration. S3Config() interface{} SetS3Config(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // A valid storage type. StorageType() *string SetStorageType(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::Connect::InstanceStorageConfig`.
The storage configuration for the 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" cfnInstanceStorageConfig := awscdk.Aws_connect.NewCfnInstanceStorageConfig(this, jsii.String("MyCfnInstanceStorageConfig"), &cfnInstanceStorageConfigProps{ instanceArn: jsii.String("instanceArn"), resourceType: jsii.String("resourceType"), storageType: jsii.String("storageType"), // the properties below are optional kinesisFirehoseConfig: &kinesisFirehoseConfigProperty{ firehoseArn: jsii.String("firehoseArn"), }, kinesisStreamConfig: &kinesisStreamConfigProperty{ streamArn: jsii.String("streamArn"), }, kinesisVideoStreamConfig: &kinesisVideoStreamConfigProperty{ prefix: jsii.String("prefix"), retentionPeriodHours: jsii.Number(123), // the properties below are optional encryptionConfig: &encryptionConfigProperty{ encryptionType: jsii.String("encryptionType"), keyId: jsii.String("keyId"), }, }, s3Config: &s3ConfigProperty{ bucketName: jsii.String("bucketName"), bucketPrefix: jsii.String("bucketPrefix"), // the properties below are optional encryptionConfig: &encryptionConfigProperty{ encryptionType: jsii.String("encryptionType"), keyId: jsii.String("keyId"), }, }, })
func NewCfnInstanceStorageConfig ¶ added in v2.42.0
func NewCfnInstanceStorageConfig(scope constructs.Construct, id *string, props *CfnInstanceStorageConfigProps) CfnInstanceStorageConfig
Create a new `AWS::Connect::InstanceStorageConfig`.
type CfnInstanceStorageConfigProps ¶ added in v2.42.0
type CfnInstanceStorageConfigProps struct { // The Amazon Resource Name (ARN) of the instance. InstanceArn *string `field:"required" json:"instanceArn" yaml:"instanceArn"` // A valid resource type. // // Following are the valid resource types: `CHAT_TRANSCRIPTS` | `CALL_RECORDINGS` | `SCHEDULED_REPORTS` | `MEDIA_STREAMS` | `CONTACT_TRACE_RECORDS` | `AGENT_EVENTS`. ResourceType *string `field:"required" json:"resourceType" yaml:"resourceType"` // A valid storage type. StorageType *string `field:"required" json:"storageType" yaml:"storageType"` // The configuration of the Kinesis Firehose delivery stream. KinesisFirehoseConfig interface{} `field:"optional" json:"kinesisFirehoseConfig" yaml:"kinesisFirehoseConfig"` // The configuration of the Kinesis data stream. KinesisStreamConfig interface{} `field:"optional" json:"kinesisStreamConfig" yaml:"kinesisStreamConfig"` // The configuration of the Kinesis video stream. KinesisVideoStreamConfig interface{} `field:"optional" json:"kinesisVideoStreamConfig" yaml:"kinesisVideoStreamConfig"` // The S3 bucket configuration. S3Config interface{} `field:"optional" json:"s3Config" yaml:"s3Config"` }
Properties for defining a `CfnInstanceStorageConfig`.
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" cfnInstanceStorageConfigProps := &cfnInstanceStorageConfigProps{ instanceArn: jsii.String("instanceArn"), resourceType: jsii.String("resourceType"), storageType: jsii.String("storageType"), // the properties below are optional kinesisFirehoseConfig: &kinesisFirehoseConfigProperty{ firehoseArn: jsii.String("firehoseArn"), }, kinesisStreamConfig: &kinesisStreamConfigProperty{ streamArn: jsii.String("streamArn"), }, kinesisVideoStreamConfig: &kinesisVideoStreamConfigProperty{ prefix: jsii.String("prefix"), retentionPeriodHours: jsii.Number(123), // the properties below are optional encryptionConfig: &encryptionConfigProperty{ encryptionType: jsii.String("encryptionType"), keyId: jsii.String("keyId"), }, }, s3Config: &s3ConfigProperty{ bucketName: jsii.String("bucketName"), bucketPrefix: jsii.String("bucketPrefix"), // the properties below are optional encryptionConfig: &encryptionConfigProperty{ encryptionType: jsii.String("encryptionType"), keyId: jsii.String("keyId"), }, }, }
type CfnInstanceStorageConfig_EncryptionConfigProperty ¶ added in v2.42.0
type CfnInstanceStorageConfig_EncryptionConfigProperty struct { // The type of encryption. EncryptionType *string `field:"required" json:"encryptionType" yaml:"encryptionType"` // The full ARN of the encryption key. // // > Be sure to provide the full ARN of the encryption key, not just the ID. KeyId *string `field:"required" json:"keyId" yaml:"keyId"` }
The encryption configuration.
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" encryptionConfigProperty := &encryptionConfigProperty{ encryptionType: jsii.String("encryptionType"), keyId: jsii.String("keyId"), }
type CfnInstanceStorageConfig_KinesisFirehoseConfigProperty ¶ added in v2.42.0
type CfnInstanceStorageConfig_KinesisFirehoseConfigProperty struct { // The Amazon Resource Name (ARN) of the delivery stream. FirehoseArn *string `field:"required" json:"firehoseArn" yaml:"firehoseArn"` }
Configuration information of a Kinesis Data Firehose delivery stream.
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" kinesisFirehoseConfigProperty := &kinesisFirehoseConfigProperty{ firehoseArn: jsii.String("firehoseArn"), }
type CfnInstanceStorageConfig_KinesisStreamConfigProperty ¶ added in v2.42.0
type CfnInstanceStorageConfig_KinesisStreamConfigProperty struct { // The Amazon Resource Name (ARN) of the data stream. StreamArn *string `field:"required" json:"streamArn" yaml:"streamArn"` }
Configuration information of a Kinesis data stream.
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" kinesisStreamConfigProperty := &kinesisStreamConfigProperty{ streamArn: jsii.String("streamArn"), }
type CfnInstanceStorageConfig_KinesisVideoStreamConfigProperty ¶ added in v2.42.0
type CfnInstanceStorageConfig_KinesisVideoStreamConfigProperty struct { // The prefix of the video stream. Prefix *string `field:"required" json:"prefix" yaml:"prefix"` // The number of hours data is retained in the stream. // // Kinesis Video Streams retains the data in a data store that is associated with the stream. // // The default value is 0, indicating that the stream does not persist data. RetentionPeriodHours *float64 `field:"required" json:"retentionPeriodHours" yaml:"retentionPeriodHours"` // The encryption configuration. EncryptionConfig interface{} `field:"optional" json:"encryptionConfig" yaml:"encryptionConfig"` }
Configuration information of a Kinesis video stream.
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" kinesisVideoStreamConfigProperty := &kinesisVideoStreamConfigProperty{ prefix: jsii.String("prefix"), retentionPeriodHours: jsii.Number(123), // the properties below are optional encryptionConfig: &encryptionConfigProperty{ encryptionType: jsii.String("encryptionType"), keyId: jsii.String("keyId"), }, }
type CfnInstanceStorageConfig_S3ConfigProperty ¶ added in v2.42.0
type CfnInstanceStorageConfig_S3ConfigProperty struct { // The S3 bucket name. BucketName *string `field:"required" json:"bucketName" yaml:"bucketName"` // The S3 bucket prefix. BucketPrefix *string `field:"required" json:"bucketPrefix" yaml:"bucketPrefix"` // The Amazon S3 encryption configuration. EncryptionConfig interface{} `field:"optional" json:"encryptionConfig" yaml:"encryptionConfig"` }
Information about the Amazon Simple Storage Service (Amazon S3) storage type.
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" s3ConfigProperty := &s3ConfigProperty{ bucketName: jsii.String("bucketName"), bucketPrefix: jsii.String("bucketPrefix"), // the properties below are optional encryptionConfig: &encryptionConfigProperty{ encryptionType: jsii.String("encryptionType"), keyId: jsii.String("keyId"), }, }
type CfnInstance_AttributesProperty ¶ added in v2.42.0
type CfnInstance_AttributesProperty struct { // `CfnInstance.AttributesProperty.InboundCalls`. InboundCalls interface{} `field:"required" json:"inboundCalls" yaml:"inboundCalls"` // `CfnInstance.AttributesProperty.OutboundCalls`. OutboundCalls interface{} `field:"required" json:"outboundCalls" yaml:"outboundCalls"` // `CfnInstance.AttributesProperty.AutoResolveBestVoices`. AutoResolveBestVoices interface{} `field:"optional" json:"autoResolveBestVoices" yaml:"autoResolveBestVoices"` // `CfnInstance.AttributesProperty.ContactflowLogs`. ContactflowLogs interface{} `field:"optional" json:"contactflowLogs" yaml:"contactflowLogs"` // `CfnInstance.AttributesProperty.ContactLens`. ContactLens interface{} `field:"optional" json:"contactLens" yaml:"contactLens"` // `CfnInstance.AttributesProperty.EarlyMedia`. EarlyMedia interface{} `field:"optional" json:"earlyMedia" yaml:"earlyMedia"` // `CfnInstance.AttributesProperty.UseCustomTTSVoices`. UseCustomTtsVoices interface{} `field:"optional" json:"useCustomTtsVoices" yaml:"useCustomTtsVoices"` }
*This is a preview release for Amazon Connect .
It is subject to change.*
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" attributesProperty := &attributesProperty{ inboundCalls: jsii.Boolean(false), outboundCalls: jsii.Boolean(false), // the properties below are optional autoResolveBestVoices: jsii.Boolean(false), contactflowLogs: jsii.Boolean(false), contactLens: jsii.Boolean(false), earlyMedia: jsii.Boolean(false), useCustomTtsVoices: jsii.Boolean(false), }
type CfnIntegrationAssociation ¶ added in v2.63.0
type CfnIntegrationAssociation interface { awscdk.CfnResource awscdk.IInspectable AttrIntegrationAssociationId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The identifier of the Amazon Connect instance. // // You can find the instanceId in the ARN of the instance. InstanceId() *string SetInstanceId(val *string) // The Amazon Resource Name (ARN) for the AppIntegration. IntegrationArn() *string SetIntegrationArn(val *string) // The integration type. IntegrationType() *string SetIntegrationType(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::Connect::IntegrationAssociation`.
Creates an AWS resource association with an 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" cfnIntegrationAssociation := awscdk.Aws_connect.NewCfnIntegrationAssociation(this, jsii.String("MyCfnIntegrationAssociation"), &cfnIntegrationAssociationProps{ instanceId: jsii.String("instanceId"), integrationArn: jsii.String("integrationArn"), integrationType: jsii.String("integrationType"), })
func NewCfnIntegrationAssociation ¶ added in v2.63.0
func NewCfnIntegrationAssociation(scope constructs.Construct, id *string, props *CfnIntegrationAssociationProps) CfnIntegrationAssociation
Create a new `AWS::Connect::IntegrationAssociation`.
type CfnIntegrationAssociationProps ¶ added in v2.63.0
type CfnIntegrationAssociationProps struct { // The identifier of the Amazon Connect instance. // // You can find the instanceId in the ARN of the instance. InstanceId *string `field:"required" json:"instanceId" yaml:"instanceId"` // The Amazon Resource Name (ARN) for the AppIntegration. IntegrationArn *string `field:"required" json:"integrationArn" yaml:"integrationArn"` // The integration type. IntegrationType *string `field:"required" json:"integrationType" yaml:"integrationType"` }
Properties for defining a `CfnIntegrationAssociation`.
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" cfnIntegrationAssociationProps := &cfnIntegrationAssociationProps{ instanceId: jsii.String("instanceId"), integrationArn: jsii.String("integrationArn"), integrationType: jsii.String("integrationType"), }
type CfnPhoneNumber ¶ added in v2.23.0
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. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. 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. 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. LogicalId() *string // The tree node. Node() constructs.Node // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The tags used to organize, track, or control access for this resource. // // For example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags() awscdk.TagManager // The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution group that phone numbers are claimed to. TargetArn() *string SetTargetArn(val *string) // The type of phone number. Type() *string SetType(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::Connect::PhoneNumber`.
Claims a phone number to the specified Amazon Connect instance or traffic distribution 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" 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 ¶ added in v2.23.0
func NewCfnPhoneNumber(scope constructs.Construct, id *string, props *CfnPhoneNumberProps) CfnPhoneNumber
Create a new `AWS::Connect::PhoneNumber`.
type CfnPhoneNumberProps ¶ added in v2.23.0
type CfnPhoneNumberProps struct { // The ISO country code. CountryCode *string `field:"required" json:"countryCode" yaml:"countryCode"` // The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution group 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. // // For example, { "tags": {"key1":"value1", "key2":"value2"} }. 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. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The 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. LogicalId() *string // The name of the quick connect. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The tags used to organize, track, or control access for this resource. // // For example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags() awscdk.TagManager // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::Connect::QuickConnect`.
Specifies a quick connect for an 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 constructs.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. // // For example, { "tags": {"key1":"value1", "key2":"value2"} }. 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 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 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 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 CfnRule ¶ added in v2.55.0
type CfnRule interface { awscdk.CfnResource awscdk.IInspectable // A list of actions to be run when the rule is triggered. Actions() interface{} SetActions(val interface{}) // The Amazon Resource Name (ARN) of the rule. AttrRuleArn() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The conditions of the rule. Function() *string SetFunction(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. LogicalId() *string // The name of the rule. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // The publish status of the rule. // // *Allowed values* : `DRAFT` | `PUBLISHED`. PublishStatus() *string SetPublishStatus(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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The tags used to organize, track, or control access for this resource. // // For example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags() awscdk.TagManager // The event source to trigger the rule. TriggerEventSource() interface{} SetTriggerEventSource(val interface{}) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::Connect::Rule`.
Creates a rule 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" var assignContactCategoryActions interface{} cfnRule := awscdk.Aws_connect.NewCfnRule(this, jsii.String("MyCfnRule"), &cfnRuleProps{ actions: &actionsProperty{ assignContactCategoryActions: []interface{}{ assignContactCategoryActions, }, eventBridgeActions: []interface{}{ &eventBridgeActionProperty{ name: jsii.String("name"), }, }, sendNotificationActions: []interface{}{ &sendNotificationActionProperty{ content: jsii.String("content"), contentType: jsii.String("contentType"), deliveryMethod: jsii.String("deliveryMethod"), recipient: ¬ificationRecipientTypeProperty{ userArns: []*string{ jsii.String("userArns"), }, userTags: map[string]*string{ "userTagsKey": jsii.String("userTags"), }, }, // the properties below are optional subject: jsii.String("subject"), }, }, taskActions: []interface{}{ &taskActionProperty{ contactFlowArn: jsii.String("contactFlowArn"), name: jsii.String("name"), // the properties below are optional description: jsii.String("description"), references: map[string]interface{}{ "referencesKey": &ReferenceProperty{ "type": jsii.String("type"), "value": jsii.String("value"), }, }, }, }, }, function: jsii.String("function"), instanceArn: jsii.String("instanceArn"), name: jsii.String("name"), publishStatus: jsii.String("publishStatus"), triggerEventSource: &ruleTriggerEventSourceProperty{ eventSourceName: jsii.String("eventSourceName"), // the properties below are optional integrationAssociationArn: jsii.String("integrationAssociationArn"), }, // the properties below are optional tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, })
func NewCfnRule ¶ added in v2.55.0
func NewCfnRule(scope constructs.Construct, id *string, props *CfnRuleProps) CfnRule
Create a new `AWS::Connect::Rule`.
type CfnRuleProps ¶ added in v2.55.0
type CfnRuleProps struct { // A list of actions to be run when the rule is triggered. Actions interface{} `field:"required" json:"actions" yaml:"actions"` // The conditions of the rule. Function *string `field:"required" json:"function" yaml:"function"` // The Amazon Resource Name (ARN) of the instance. InstanceArn *string `field:"required" json:"instanceArn" yaml:"instanceArn"` // The name of the rule. Name *string `field:"required" json:"name" yaml:"name"` // The publish status of the rule. // // *Allowed values* : `DRAFT` | `PUBLISHED`. PublishStatus *string `field:"required" json:"publishStatus" yaml:"publishStatus"` // The event source to trigger the rule. TriggerEventSource interface{} `field:"required" json:"triggerEventSource" yaml:"triggerEventSource"` // The tags used to organize, track, or control access for this resource. // // For example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnRule`.
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 assignContactCategoryActions interface{} cfnRuleProps := &cfnRuleProps{ actions: &actionsProperty{ assignContactCategoryActions: []interface{}{ assignContactCategoryActions, }, eventBridgeActions: []interface{}{ &eventBridgeActionProperty{ name: jsii.String("name"), }, }, sendNotificationActions: []interface{}{ &sendNotificationActionProperty{ content: jsii.String("content"), contentType: jsii.String("contentType"), deliveryMethod: jsii.String("deliveryMethod"), recipient: ¬ificationRecipientTypeProperty{ userArns: []*string{ jsii.String("userArns"), }, userTags: map[string]*string{ "userTagsKey": jsii.String("userTags"), }, }, // the properties below are optional subject: jsii.String("subject"), }, }, taskActions: []interface{}{ &taskActionProperty{ contactFlowArn: jsii.String("contactFlowArn"), name: jsii.String("name"), // the properties below are optional description: jsii.String("description"), references: map[string]interface{}{ "referencesKey": &ReferenceProperty{ "type": jsii.String("type"), "value": jsii.String("value"), }, }, }, }, }, function: jsii.String("function"), instanceArn: jsii.String("instanceArn"), name: jsii.String("name"), publishStatus: jsii.String("publishStatus"), triggerEventSource: &ruleTriggerEventSourceProperty{ eventSourceName: jsii.String("eventSourceName"), // the properties below are optional integrationAssociationArn: jsii.String("integrationAssociationArn"), }, // the properties below are optional tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }
type CfnRule_ActionsProperty ¶ added in v2.55.0
type CfnRule_ActionsProperty struct { // Information about the contact category action. // // The syntax can be empty, for example, `{}` . AssignContactCategoryActions interface{} `field:"optional" json:"assignContactCategoryActions" yaml:"assignContactCategoryActions"` // Information about the EventBridge action. EventBridgeActions interface{} `field:"optional" json:"eventBridgeActions" yaml:"eventBridgeActions"` // Information about the send notification action. SendNotificationActions interface{} `field:"optional" json:"sendNotificationActions" yaml:"sendNotificationActions"` // Information about the task action. // // This field is required if `TriggerEventSource` is one of the following values: `OnZendeskTicketCreate` | `OnZendeskTicketStatusUpdate` | `OnSalesforceCaseCreate`. TaskActions interface{} `field:"optional" json:"taskActions" yaml:"taskActions"` }
A list of actions to be run when the rule is triggered.
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 assignContactCategoryActions interface{} actionsProperty := &actionsProperty{ assignContactCategoryActions: []interface{}{ assignContactCategoryActions, }, eventBridgeActions: []interface{}{ &eventBridgeActionProperty{ name: jsii.String("name"), }, }, sendNotificationActions: []interface{}{ &sendNotificationActionProperty{ content: jsii.String("content"), contentType: jsii.String("contentType"), deliveryMethod: jsii.String("deliveryMethod"), recipient: ¬ificationRecipientTypeProperty{ userArns: []*string{ jsii.String("userArns"), }, userTags: map[string]*string{ "userTagsKey": jsii.String("userTags"), }, }, // the properties below are optional subject: jsii.String("subject"), }, }, taskActions: []interface{}{ &taskActionProperty{ contactFlowArn: jsii.String("contactFlowArn"), name: jsii.String("name"), // the properties below are optional description: jsii.String("description"), references: map[string]interface{}{ "referencesKey": &ReferenceProperty{ "type": jsii.String("type"), "value": jsii.String("value"), }, }, }, }, }
type CfnRule_EventBridgeActionProperty ¶ added in v2.55.0
type CfnRule_EventBridgeActionProperty struct { // The name. Name *string `field:"required" json:"name" yaml:"name"` }
The EventBridge action definition.
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" eventBridgeActionProperty := &eventBridgeActionProperty{ name: jsii.String("name"), }
type CfnRule_NotificationRecipientTypeProperty ¶ added in v2.55.0
type CfnRule_NotificationRecipientTypeProperty struct { // The Amazon Resource Name (ARN) of the user account. UserArns *[]*string `field:"optional" json:"userArns" yaml:"userArns"` // The tags used to organize, track, or control access for this resource. // // For example, { "tags": {"key1":"value1", "key2":"value2"} }. Amazon Connect users with the specified tags will be notified. UserTags interface{} `field:"optional" json:"userTags" yaml:"userTags"` }
The type of notification recipient.
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" notificationRecipientTypeProperty := ¬ificationRecipientTypeProperty{ userArns: []*string{ jsii.String("userArns"), }, userTags: map[string]*string{ "userTagsKey": jsii.String("userTags"), }, }
type CfnRule_ReferenceProperty ¶ added in v2.55.0
type CfnRule_ReferenceProperty struct { // The type of the reference. `DATE` must be of type Epoch timestamp. // // *Allowed values* : `URL` | `ATTACHMENT` | `NUMBER` | `STRING` | `DATE` | `EMAIL`. Type *string `field:"required" json:"type" yaml:"type"` // A valid value for the reference. // // For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP). Value *string `field:"required" json:"value" yaml:"value"` }
Information about the reference when the `referenceType` is `URL` .
Otherwise, null. (Supports variable injection in the `Value` field.)
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" referenceProperty := &referenceProperty{ type: jsii.String("type"), value: jsii.String("value"), }
type CfnRule_RuleTriggerEventSourceProperty ¶ added in v2.55.0
type CfnRule_RuleTriggerEventSourceProperty struct { // The name of the event source. // // *Allowed values* : `OnPostCallAnalysisAvailable` | `OnRealTimeCallAnalysisAvailable` | `OnPostChatAnalysisAvailable` | `OnZendeskTicketCreate` | `OnZendeskTicketStatusUpdate` | `OnSalesforceCaseCreate`. EventSourceName *string `field:"required" json:"eventSourceName" yaml:"eventSourceName"` // The Amazon Resource Name (ARN) for the integration association. // // `IntegrationAssociationArn` is required if `TriggerEventSource` is one of the following values: `OnZendeskTicketCreate` | `OnZendeskTicketStatusUpdate` | `OnSalesforceCaseCreate`. IntegrationAssociationArn *string `field:"optional" json:"integrationAssociationArn" yaml:"integrationAssociationArn"` }
The name of the event source.
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" ruleTriggerEventSourceProperty := &ruleTriggerEventSourceProperty{ eventSourceName: jsii.String("eventSourceName"), // the properties below are optional integrationAssociationArn: jsii.String("integrationAssociationArn"), }
type CfnRule_SendNotificationActionProperty ¶ added in v2.55.0
type CfnRule_SendNotificationActionProperty struct { // Notification content. // // Supports variable injection. For more information, see [JSONPath reference](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) in the *Amazon Connect Administrators Guide* . Content *string `field:"required" json:"content" yaml:"content"` // Content type format. // // *Allowed value* : `PLAIN_TEXT`. ContentType *string `field:"required" json:"contentType" yaml:"contentType"` // Notification delivery method. // // *Allowed value* : `EMAIL`. DeliveryMethod *string `field:"required" json:"deliveryMethod" yaml:"deliveryMethod"` // Notification recipient. Recipient interface{} `field:"required" json:"recipient" yaml:"recipient"` // The subject of the email if the delivery method is `EMAIL` . // // Supports variable injection. For more information, see [JSONPath reference](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) in the *Amazon Connect Administrators Guide* . Subject *string `field:"optional" json:"subject" yaml:"subject"` }
Information about the send notification action.
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" sendNotificationActionProperty := &sendNotificationActionProperty{ content: jsii.String("content"), contentType: jsii.String("contentType"), deliveryMethod: jsii.String("deliveryMethod"), recipient: ¬ificationRecipientTypeProperty{ userArns: []*string{ jsii.String("userArns"), }, userTags: map[string]*string{ "userTagsKey": jsii.String("userTags"), }, }, // the properties below are optional subject: jsii.String("subject"), }
type CfnRule_TaskActionProperty ¶ added in v2.55.0
type CfnRule_TaskActionProperty struct { // The Amazon Resource Name (ARN) of the flow. ContactFlowArn *string `field:"required" json:"contactFlowArn" yaml:"contactFlowArn"` // The name. // // Supports variable injection. For more information, see [JSONPath reference](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) in the *Amazon Connect Administrators Guide* . Name *string `field:"required" json:"name" yaml:"name"` // The description. // // Supports variable injection. For more information, see [JSONPath reference](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) in the *Amazon Connect Administrators Guide* . Description *string `field:"optional" json:"description" yaml:"description"` // Information about the reference when the `referenceType` is `URL` . // // Otherwise, null. `URL` is the only accepted type. (Supports variable injection in the `Value` field.) References interface{} `field:"optional" json:"references" yaml:"references"` }
Information about the task action.
This field is required if `TriggerEventSource` is one of the following values: `OnZendeskTicketCreate` | `OnZendeskTicketStatusUpdate` | `OnSalesforceCaseCreate`.
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" taskActionProperty := &taskActionProperty{ contactFlowArn: jsii.String("contactFlowArn"), name: jsii.String("name"), // the properties below are optional description: jsii.String("description"), references: map[string]interface{}{ "referencesKey": &ReferenceProperty{ "type": jsii.String("type"), "value": jsii.String("value"), }, }, }
type CfnSecurityKey ¶ added in v2.63.0
type CfnSecurityKey interface { awscdk.CfnResource awscdk.IInspectable AttrAssociationId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // `AWS::Connect::SecurityKey.InstanceId`. InstanceId() *string SetInstanceId(val *string) // The key of the security key. Key() *string SetKey(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::Connect::SecurityKey`.
Configuration information of the security key.
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" cfnSecurityKey := awscdk.Aws_connect.NewCfnSecurityKey(this, jsii.String("MyCfnSecurityKey"), &cfnSecurityKeyProps{ instanceId: jsii.String("instanceId"), key: jsii.String("key"), })
func NewCfnSecurityKey ¶ added in v2.63.0
func NewCfnSecurityKey(scope constructs.Construct, id *string, props *CfnSecurityKeyProps) CfnSecurityKey
Create a new `AWS::Connect::SecurityKey`.
type CfnSecurityKeyProps ¶ added in v2.63.0
type CfnSecurityKeyProps struct { // `AWS::Connect::SecurityKey.InstanceId`. InstanceId *string `field:"required" json:"instanceId" yaml:"instanceId"` // The key of the security key. Key *string `field:"required" json:"key" yaml:"key"` }
Properties for defining a `CfnSecurityKey`.
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" cfnSecurityKeyProps := &cfnSecurityKeyProps{ instanceId: jsii.String("instanceId"), key: jsii.String("key"), }
type CfnTaskTemplate ¶ added in v2.29.0
type CfnTaskTemplate interface { awscdk.CfnResource awscdk.IInspectable // The Amazon Resource Name (ARN) of the task template. AttrArn() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. ClientToken() *string SetClientToken(val *string) // Constraints that are applicable to the fields listed. // // The values can be represented in either JSON or YAML format. For an example of the JSON configuration, see *Examples* at the bottom of this page. Constraints() interface{} SetConstraints(val interface{}) // The Amazon Resource Name (ARN) of the flow that runs by default when a task is created by referencing this template. // // `ContactFlowArn` is not required when there is a field with `fieldType` = `QUICK_CONNECT` . 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. CreationStack() *[]*string // The default values for fields when a task is created by referencing this template. Defaults() interface{} SetDefaults(val interface{}) // The description of the task template. Description() *string SetDescription(val *string) // Fields that are part of the template. // // A template requires at least one field that has type `Name` . Fields() interface{} SetFields(val interface{}) // 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. LogicalId() *string // The name of the task template. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The status of the task template. Status() *string SetStatus(val *string) // The tags used to organize, track, or control access for this resource. Tags() awscdk.TagManager // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::Connect::TaskTemplate`.
Specifies a task template for a 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" 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 ¶ added in v2.29.0
func NewCfnTaskTemplate(scope constructs.Construct, id *string, props *CfnTaskTemplateProps) CfnTaskTemplate
Create a new `AWS::Connect::TaskTemplate`.
type CfnTaskTemplateProps ¶ added in v2.29.0
type CfnTaskTemplateProps struct { // The Amazon Resource Name (ARN) of the Amazon Connect instance. InstanceArn *string `field:"required" json:"instanceArn" yaml:"instanceArn"` // A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. ClientToken *string `field:"optional" json:"clientToken" yaml:"clientToken"` // Constraints that are applicable to the fields listed. // // The values can be represented in either JSON or YAML format. For an example of the JSON configuration, see *Examples* at the bottom of this page. Constraints interface{} `field:"optional" json:"constraints" yaml:"constraints"` // The Amazon Resource Name (ARN) of the flow that runs by default when a task is created by referencing this template. // // `ContactFlowArn` is not required when there is a field with `fieldType` = `QUICK_CONNECT` . ContactFlowArn *string `field:"optional" json:"contactFlowArn" yaml:"contactFlowArn"` // The default values for fields when a task is created by referencing this template. Defaults interface{} `field:"optional" json:"defaults" yaml:"defaults"` // The description of the task template. Description *string `field:"optional" json:"description" yaml:"description"` // Fields that are part of the template. // // A template requires at least one field that has type `Name` . Fields interface{} `field:"optional" json:"fields" yaml:"fields"` // The name of the task template. Name *string `field:"optional" json:"name" yaml:"name"` // The status of the task template. Status *string `field:"optional" json:"status" yaml:"status"` // 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 `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_ConstraintsProperty ¶ added in v2.55.0
type CfnTaskTemplate_ConstraintsProperty struct { // `CfnTaskTemplate.ConstraintsProperty.InvisibleFields`. InvisibleFields interface{} `field:"optional" json:"invisibleFields" yaml:"invisibleFields"` // `CfnTaskTemplate.ConstraintsProperty.ReadOnlyFields`. ReadOnlyFields interface{} `field:"optional" json:"readOnlyFields" yaml:"readOnlyFields"` // `CfnTaskTemplate.ConstraintsProperty.RequiredFields`. RequiredFields interface{} `field:"optional" json:"requiredFields" yaml:"requiredFields"` }
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" constraintsProperty := &constraintsProperty{ invisibleFields: []interface{}{ &invisibleFieldInfoProperty{ id: &fieldIdentifierProperty{ name: jsii.String("name"), }, }, }, readOnlyFields: []interface{}{ &readOnlyFieldInfoProperty{ id: &fieldIdentifierProperty{ name: jsii.String("name"), }, }, }, requiredFields: []interface{}{ &requiredFieldInfoProperty{ id: &fieldIdentifierProperty{ name: jsii.String("name"), }, }, }, }
type CfnTaskTemplate_DefaultFieldValueProperty ¶ added in v2.29.0
type CfnTaskTemplate_DefaultFieldValueProperty struct { // Default value for the field. DefaultValue *string `field:"required" json:"defaultValue" yaml:"defaultValue"` // Identifier of a field. Id interface{} `field:"required" json:"id" yaml:"id"` }
Describes a default field and its corresponding value.
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 ¶ added in v2.29.0
type CfnTaskTemplate_FieldIdentifierProperty struct { // The name of the task template field. Name *string `field:"required" json:"name" yaml:"name"` }
The identifier of the task template field.
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 ¶ added in v2.29.0
type CfnTaskTemplate_FieldProperty struct { // The unique identifier for the field. Id interface{} `field:"required" json:"id" yaml:"id"` // Indicates the type of field. // // Following are the valid field types: `NAME` `DESCRIPTION` | `SCHEDULED_TIME` | `QUICK_CONNECT` | `URL` | `NUMBER` | `TEXT` | `TEXT_AREA` | `DATE_TIME` | `BOOLEAN` | `SINGLE_SELECT` | `EMAIL`. Type *string `field:"required" json:"type" yaml:"type"` // The description of the field. Description *string `field:"optional" json:"description" yaml:"description"` // A list of options for a single select field. SingleSelectOptions *[]*string `field:"optional" json:"singleSelectOptions" yaml:"singleSelectOptions"` }
Describes a single task template field.
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 CfnTaskTemplate_InvisibleFieldInfoProperty ¶ added in v2.55.0
type CfnTaskTemplate_InvisibleFieldInfoProperty struct {
// Identifier of the invisible field.
Id interface{} `field:"required" json:"id" yaml:"id"`
}
A field that is invisible to an 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" invisibleFieldInfoProperty := &invisibleFieldInfoProperty{ id: &fieldIdentifierProperty{ name: jsii.String("name"), }, }
type CfnTaskTemplate_ReadOnlyFieldInfoProperty ¶ added in v2.55.0
type CfnTaskTemplate_ReadOnlyFieldInfoProperty struct {
// Identifier of the read-only field.
Id interface{} `field:"required" json:"id" yaml:"id"`
}
Indicates a field that is read-only to an 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" readOnlyFieldInfoProperty := &readOnlyFieldInfoProperty{ id: &fieldIdentifierProperty{ name: jsii.String("name"), }, }
type CfnTaskTemplate_RequiredFieldInfoProperty ¶ added in v2.55.0
type CfnTaskTemplate_RequiredFieldInfoProperty struct {
// The unique identifier for the field.
Id interface{} `field:"required" json:"id" yaml:"id"`
}
Information about a required field.
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" requiredFieldInfoProperty := &requiredFieldInfoProperty{ id: &fieldIdentifierProperty{ name: jsii.String("name"), }, }
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. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The 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. LogicalId() *string // The tree node. Node() constructs.Node // 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 })`. 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). Stack() awscdk.Stack // The tags. Tags() awscdk.TagManager // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The user name assigned to the user account. Username() *string SetUsername(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::Connect::User`.
Specifies a user account for an 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"), mobile: jsii.String("mobile"), secondaryEmail: jsii.String("secondaryEmail"), }, password: jsii.String("password"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, })
func NewCfnUser ¶
func NewCfnUser(scope constructs.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. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The 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. LogicalId() *string // The name of the user hierarchy group. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::Connect::UserHierarchyGroup`.
Specifies 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 constructs.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"), mobile: jsii.String("mobile"), secondaryEmail: jsii.String("secondaryEmail"), }, 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"` // The user's mobile number. Mobile *string `field:"optional" json:"mobile" yaml:"mobile"` // The user's secondary email address. // // If you provide a secondary email, the user receives email notifications -- other than password reset notifications -- to this email address instead of to their primary email address. // // *Pattern* : `(?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}` SecondaryEmail *string `field:"optional" json:"secondaryEmail" yaml:"secondaryEmail"` }
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"), mobile: jsii.String("mobile"), secondaryEmail: jsii.String("secondaryEmail"), }
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. // // > When returned by a `SearchUsers` call, `AfterContactWorkTimeLimit` is returned in milliseconds. 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"), }
Source Files ¶
- awsconnect.go
- awsconnect_CfnApprovedOrigin.go
- awsconnect_CfnApprovedOriginProps.go
- awsconnect_CfnApprovedOrigin__runtime_type_checks.go
- awsconnect_CfnContactFlow.go
- awsconnect_CfnContactFlowModule.go
- awsconnect_CfnContactFlowModuleProps.go
- awsconnect_CfnContactFlowModule__runtime_type_checks.go
- awsconnect_CfnContactFlowProps.go
- awsconnect_CfnContactFlow__runtime_type_checks.go
- awsconnect_CfnHoursOfOperation.go
- awsconnect_CfnHoursOfOperationProps.go
- awsconnect_CfnHoursOfOperation_HoursOfOperationConfigProperty.go
- awsconnect_CfnHoursOfOperation_HoursOfOperationTimeSliceProperty.go
- awsconnect_CfnHoursOfOperation__runtime_type_checks.go
- awsconnect_CfnInstance.go
- awsconnect_CfnInstanceProps.go
- awsconnect_CfnInstanceStorageConfig.go
- awsconnect_CfnInstanceStorageConfigProps.go
- awsconnect_CfnInstanceStorageConfig_EncryptionConfigProperty.go
- awsconnect_CfnInstanceStorageConfig_KinesisFirehoseConfigProperty.go
- awsconnect_CfnInstanceStorageConfig_KinesisStreamConfigProperty.go
- awsconnect_CfnInstanceStorageConfig_KinesisVideoStreamConfigProperty.go
- awsconnect_CfnInstanceStorageConfig_S3ConfigProperty.go
- awsconnect_CfnInstanceStorageConfig__runtime_type_checks.go
- awsconnect_CfnInstance_AttributesProperty.go
- awsconnect_CfnInstance__runtime_type_checks.go
- awsconnect_CfnIntegrationAssociation.go
- awsconnect_CfnIntegrationAssociationProps.go
- awsconnect_CfnIntegrationAssociation__runtime_type_checks.go
- awsconnect_CfnPhoneNumber.go
- awsconnect_CfnPhoneNumberProps.go
- awsconnect_CfnPhoneNumber__runtime_type_checks.go
- awsconnect_CfnQuickConnect.go
- awsconnect_CfnQuickConnectProps.go
- awsconnect_CfnQuickConnect_PhoneNumberQuickConnectConfigProperty.go
- awsconnect_CfnQuickConnect_QueueQuickConnectConfigProperty.go
- awsconnect_CfnQuickConnect_QuickConnectConfigProperty.go
- awsconnect_CfnQuickConnect_UserQuickConnectConfigProperty.go
- awsconnect_CfnQuickConnect__runtime_type_checks.go
- awsconnect_CfnRule.go
- awsconnect_CfnRuleProps.go
- awsconnect_CfnRule_ActionsProperty.go
- awsconnect_CfnRule_EventBridgeActionProperty.go
- awsconnect_CfnRule_NotificationRecipientTypeProperty.go
- awsconnect_CfnRule_ReferenceProperty.go
- awsconnect_CfnRule_RuleTriggerEventSourceProperty.go
- awsconnect_CfnRule_SendNotificationActionProperty.go
- awsconnect_CfnRule_TaskActionProperty.go
- awsconnect_CfnRule__runtime_type_checks.go
- awsconnect_CfnSecurityKey.go
- awsconnect_CfnSecurityKeyProps.go
- awsconnect_CfnSecurityKey__runtime_type_checks.go
- awsconnect_CfnTaskTemplate.go
- awsconnect_CfnTaskTemplateProps.go
- awsconnect_CfnTaskTemplate_ConstraintsProperty.go
- awsconnect_CfnTaskTemplate_DefaultFieldValueProperty.go
- awsconnect_CfnTaskTemplate_FieldIdentifierProperty.go
- awsconnect_CfnTaskTemplate_FieldProperty.go
- awsconnect_CfnTaskTemplate_InvisibleFieldInfoProperty.go
- awsconnect_CfnTaskTemplate_ReadOnlyFieldInfoProperty.go
- awsconnect_CfnTaskTemplate_RequiredFieldInfoProperty.go
- awsconnect_CfnTaskTemplate__runtime_type_checks.go
- awsconnect_CfnUser.go
- awsconnect_CfnUserHierarchyGroup.go
- awsconnect_CfnUserHierarchyGroupProps.go
- awsconnect_CfnUserHierarchyGroup__runtime_type_checks.go
- awsconnect_CfnUserProps.go
- awsconnect_CfnUser_UserIdentityInfoProperty.go
- awsconnect_CfnUser_UserPhoneConfigProperty.go
- awsconnect_CfnUser__runtime_type_checks.go