Documentation
¶
Index ¶
- func CfnCustomResource_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCustomResource_IsCfnElement(x interface{}) *bool
- func CfnCustomResource_IsCfnResource(x interface{}) *bool
- func CfnCustomResource_IsConstruct(x interface{}) *bool
- func CfnGuardHook_CFN_RESOURCE_TYPE_NAME() *string
- func CfnGuardHook_IsCfnElement(x interface{}) *bool
- func CfnGuardHook_IsCfnResource(x interface{}) *bool
- func CfnGuardHook_IsConstruct(x interface{}) *bool
- func CfnHookDefaultVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnHookDefaultVersion_IsCfnElement(x interface{}) *bool
- func CfnHookDefaultVersion_IsCfnResource(x interface{}) *bool
- func CfnHookDefaultVersion_IsConstruct(x interface{}) *bool
- func CfnHookTypeConfig_CFN_RESOURCE_TYPE_NAME() *string
- func CfnHookTypeConfig_IsCfnElement(x interface{}) *bool
- func CfnHookTypeConfig_IsCfnResource(x interface{}) *bool
- func CfnHookTypeConfig_IsConstruct(x interface{}) *bool
- func CfnHookVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnHookVersion_IsCfnElement(x interface{}) *bool
- func CfnHookVersion_IsCfnResource(x interface{}) *bool
- func CfnHookVersion_IsConstruct(x interface{}) *bool
- func CfnLambdaHook_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLambdaHook_IsCfnElement(x interface{}) *bool
- func CfnLambdaHook_IsCfnResource(x interface{}) *bool
- func CfnLambdaHook_IsConstruct(x interface{}) *bool
- func CfnMacro_CFN_RESOURCE_TYPE_NAME() *string
- func CfnMacro_IsCfnElement(x interface{}) *bool
- func CfnMacro_IsCfnResource(x interface{}) *bool
- func CfnMacro_IsConstruct(x interface{}) *bool
- func CfnModuleDefaultVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnModuleDefaultVersion_IsCfnElement(x interface{}) *bool
- func CfnModuleDefaultVersion_IsCfnResource(x interface{}) *bool
- func CfnModuleDefaultVersion_IsConstruct(x interface{}) *bool
- func CfnModuleVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnModuleVersion_IsCfnElement(x interface{}) *bool
- func CfnModuleVersion_IsCfnResource(x interface{}) *bool
- func CfnModuleVersion_IsConstruct(x interface{}) *bool
- func CfnPublicTypeVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPublicTypeVersion_IsCfnElement(x interface{}) *bool
- func CfnPublicTypeVersion_IsCfnResource(x interface{}) *bool
- func CfnPublicTypeVersion_IsConstruct(x interface{}) *bool
- func CfnPublisher_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPublisher_IsCfnElement(x interface{}) *bool
- func CfnPublisher_IsCfnResource(x interface{}) *bool
- func CfnPublisher_IsConstruct(x interface{}) *bool
- func CfnResourceDefaultVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnResourceDefaultVersion_IsCfnElement(x interface{}) *bool
- func CfnResourceDefaultVersion_IsCfnResource(x interface{}) *bool
- func CfnResourceDefaultVersion_IsConstruct(x interface{}) *bool
- func CfnResourceVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnResourceVersion_IsCfnElement(x interface{}) *bool
- func CfnResourceVersion_IsCfnResource(x interface{}) *bool
- func CfnResourceVersion_IsConstruct(x interface{}) *bool
- func CfnStackSet_CFN_RESOURCE_TYPE_NAME() *string
- func CfnStackSet_IsCfnElement(x interface{}) *bool
- func CfnStackSet_IsCfnResource(x interface{}) *bool
- func CfnStackSet_IsConstruct(x interface{}) *bool
- func CfnStack_CFN_RESOURCE_TYPE_NAME() *string
- func CfnStack_IsCfnElement(x interface{}) *bool
- func CfnStack_IsCfnResource(x interface{}) *bool
- func CfnStack_IsConstruct(x interface{}) *bool
- func CfnTypeActivation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTypeActivation_IsCfnElement(x interface{}) *bool
- func CfnTypeActivation_IsCfnResource(x interface{}) *bool
- func CfnTypeActivation_IsConstruct(x interface{}) *bool
- func CfnWaitConditionHandle_CFN_RESOURCE_TYPE_NAME() *string
- func CfnWaitConditionHandle_IsCfnElement(x interface{}) *bool
- func CfnWaitConditionHandle_IsCfnResource(x interface{}) *bool
- func CfnWaitConditionHandle_IsConstruct(x interface{}) *bool
- func CfnWaitCondition_CFN_RESOURCE_TYPE_NAME() *string
- func CfnWaitCondition_IsCfnElement(x interface{}) *bool
- func CfnWaitCondition_IsCfnResource(x interface{}) *bool
- func CfnWaitCondition_IsConstruct(x interface{}) *bool
- func NewCfnCustomResource_Override(c CfnCustomResource, scope constructs.Construct, id *string, ...)
- func NewCfnGuardHook_Override(c CfnGuardHook, scope constructs.Construct, id *string, ...)
- func NewCfnHookDefaultVersion_Override(c CfnHookDefaultVersion, scope constructs.Construct, id *string, ...)
- func NewCfnHookTypeConfig_Override(c CfnHookTypeConfig, scope constructs.Construct, id *string, ...)
- func NewCfnHookVersion_Override(c CfnHookVersion, scope constructs.Construct, id *string, ...)
- func NewCfnLambdaHook_Override(c CfnLambdaHook, scope constructs.Construct, id *string, ...)
- func NewCfnMacro_Override(c CfnMacro, scope constructs.Construct, id *string, props *CfnMacroProps)
- func NewCfnModuleDefaultVersion_Override(c CfnModuleDefaultVersion, scope constructs.Construct, id *string, ...)
- func NewCfnModuleVersion_Override(c CfnModuleVersion, scope constructs.Construct, id *string, ...)
- func NewCfnPublicTypeVersion_Override(c CfnPublicTypeVersion, scope constructs.Construct, id *string, ...)
- func NewCfnPublisher_Override(c CfnPublisher, scope constructs.Construct, id *string, ...)
- func NewCfnResourceDefaultVersion_Override(c CfnResourceDefaultVersion, scope constructs.Construct, id *string, ...)
- func NewCfnResourceVersion_Override(c CfnResourceVersion, scope constructs.Construct, id *string, ...)
- func NewCfnStackSet_Override(c CfnStackSet, scope constructs.Construct, id *string, props *CfnStackSetProps)
- func NewCfnStack_Override(c CfnStack, scope constructs.Construct, id *string, props *CfnStackProps)
- func NewCfnTypeActivation_Override(c CfnTypeActivation, scope constructs.Construct, id *string, ...)
- func NewCfnWaitConditionHandle_Override(c CfnWaitConditionHandle, scope constructs.Construct, id *string, ...)
- func NewCfnWaitCondition_Override(c CfnWaitCondition, scope constructs.Construct, id *string, ...)
- type CfnCustomResource
- type CfnCustomResourceProps
- type CfnGuardHook
- type CfnGuardHookProps
- type CfnGuardHook_HookTargetProperty
- type CfnGuardHook_OptionsProperty
- type CfnGuardHook_S3LocationProperty
- type CfnGuardHook_StackFiltersProperty
- type CfnGuardHook_StackNamesProperty
- type CfnGuardHook_StackRolesProperty
- type CfnGuardHook_TargetFiltersProperty
- type CfnHookDefaultVersion
- type CfnHookDefaultVersionProps
- type CfnHookTypeConfig
- type CfnHookTypeConfigProps
- type CfnHookVersion
- type CfnHookVersionProps
- type CfnHookVersion_LoggingConfigProperty
- type CfnLambdaHook
- type CfnLambdaHookProps
- type CfnLambdaHook_HookTargetProperty
- type CfnLambdaHook_StackFiltersProperty
- type CfnLambdaHook_StackNamesProperty
- type CfnLambdaHook_StackRolesProperty
- type CfnLambdaHook_TargetFiltersProperty
- type CfnMacro
- type CfnMacroProps
- type CfnModuleDefaultVersion
- type CfnModuleDefaultVersionProps
- type CfnModuleVersion
- type CfnModuleVersionProps
- type CfnPublicTypeVersion
- type CfnPublicTypeVersionProps
- type CfnPublisher
- type CfnPublisherProps
- type CfnResourceDefaultVersion
- type CfnResourceDefaultVersionProps
- type CfnResourceVersion
- type CfnResourceVersionProps
- type CfnResourceVersion_LoggingConfigProperty
- type CfnStack
- type CfnStackProps
- type CfnStackSet
- type CfnStackSetProps
- type CfnStackSet_AutoDeploymentProperty
- type CfnStackSet_DeploymentTargetsProperty
- type CfnStackSet_ManagedExecutionProperty
- type CfnStackSet_OperationPreferencesProperty
- type CfnStackSet_ParameterProperty
- type CfnStackSet_StackInstancesProperty
- type CfnStack_OutputProperty
- type CfnTypeActivation
- type CfnTypeActivationProps
- type CfnTypeActivation_LoggingConfigProperty
- type CfnWaitCondition
- type CfnWaitConditionHandle
- type CfnWaitConditionHandleProps
- type CfnWaitConditionProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnCustomResource_CFN_RESOURCE_TYPE_NAME ¶
func CfnCustomResource_CFN_RESOURCE_TYPE_NAME() *string
func CfnCustomResource_IsCfnElement ¶
func CfnCustomResource_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 CfnCustomResource_IsCfnResource ¶
func CfnCustomResource_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnCustomResource_IsConstruct ¶
func CfnCustomResource_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 CfnGuardHook_CFN_RESOURCE_TYPE_NAME ¶ added in v2.168.0
func CfnGuardHook_CFN_RESOURCE_TYPE_NAME() *string
func CfnGuardHook_IsCfnElement ¶ added in v2.168.0
func CfnGuardHook_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 CfnGuardHook_IsCfnResource ¶ added in v2.168.0
func CfnGuardHook_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnGuardHook_IsConstruct ¶ added in v2.168.0
func CfnGuardHook_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 CfnHookDefaultVersion_CFN_RESOURCE_TYPE_NAME ¶ added in v2.13.0
func CfnHookDefaultVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnHookDefaultVersion_IsCfnElement ¶ added in v2.13.0
func CfnHookDefaultVersion_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 CfnHookDefaultVersion_IsCfnResource ¶ added in v2.13.0
func CfnHookDefaultVersion_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnHookDefaultVersion_IsConstruct ¶ added in v2.13.0
func CfnHookDefaultVersion_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 CfnHookTypeConfig_CFN_RESOURCE_TYPE_NAME ¶ added in v2.13.0
func CfnHookTypeConfig_CFN_RESOURCE_TYPE_NAME() *string
func CfnHookTypeConfig_IsCfnElement ¶ added in v2.13.0
func CfnHookTypeConfig_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 CfnHookTypeConfig_IsCfnResource ¶ added in v2.13.0
func CfnHookTypeConfig_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnHookTypeConfig_IsConstruct ¶ added in v2.13.0
func CfnHookTypeConfig_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 CfnHookVersion_CFN_RESOURCE_TYPE_NAME ¶ added in v2.13.0
func CfnHookVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnHookVersion_IsCfnElement ¶ added in v2.13.0
func CfnHookVersion_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 CfnHookVersion_IsCfnResource ¶ added in v2.13.0
func CfnHookVersion_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnHookVersion_IsConstruct ¶ added in v2.13.0
func CfnHookVersion_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 CfnLambdaHook_CFN_RESOURCE_TYPE_NAME ¶ added in v2.168.0
func CfnLambdaHook_CFN_RESOURCE_TYPE_NAME() *string
func CfnLambdaHook_IsCfnElement ¶ added in v2.168.0
func CfnLambdaHook_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 CfnLambdaHook_IsCfnResource ¶ added in v2.168.0
func CfnLambdaHook_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnLambdaHook_IsConstruct ¶ added in v2.168.0
func CfnLambdaHook_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 CfnMacro_CFN_RESOURCE_TYPE_NAME ¶
func CfnMacro_CFN_RESOURCE_TYPE_NAME() *string
func CfnMacro_IsCfnElement ¶
func CfnMacro_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 CfnMacro_IsCfnResource ¶
func CfnMacro_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnMacro_IsConstruct ¶
func CfnMacro_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 CfnModuleDefaultVersion_CFN_RESOURCE_TYPE_NAME ¶
func CfnModuleDefaultVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnModuleDefaultVersion_IsCfnElement ¶
func CfnModuleDefaultVersion_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 CfnModuleDefaultVersion_IsCfnResource ¶
func CfnModuleDefaultVersion_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnModuleDefaultVersion_IsConstruct ¶
func CfnModuleDefaultVersion_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 CfnModuleVersion_CFN_RESOURCE_TYPE_NAME ¶
func CfnModuleVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnModuleVersion_IsCfnElement ¶
func CfnModuleVersion_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 CfnModuleVersion_IsCfnResource ¶
func CfnModuleVersion_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnModuleVersion_IsConstruct ¶
func CfnModuleVersion_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 CfnPublicTypeVersion_CFN_RESOURCE_TYPE_NAME ¶
func CfnPublicTypeVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnPublicTypeVersion_IsCfnElement ¶
func CfnPublicTypeVersion_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 CfnPublicTypeVersion_IsCfnResource ¶
func CfnPublicTypeVersion_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnPublicTypeVersion_IsConstruct ¶
func CfnPublicTypeVersion_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 CfnPublisher_CFN_RESOURCE_TYPE_NAME ¶
func CfnPublisher_CFN_RESOURCE_TYPE_NAME() *string
func CfnPublisher_IsCfnElement ¶
func CfnPublisher_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 CfnPublisher_IsCfnResource ¶
func CfnPublisher_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnPublisher_IsConstruct ¶
func CfnPublisher_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 CfnResourceDefaultVersion_CFN_RESOURCE_TYPE_NAME ¶
func CfnResourceDefaultVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnResourceDefaultVersion_IsCfnElement ¶
func CfnResourceDefaultVersion_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 CfnResourceDefaultVersion_IsCfnResource ¶
func CfnResourceDefaultVersion_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnResourceDefaultVersion_IsConstruct ¶
func CfnResourceDefaultVersion_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 CfnResourceVersion_CFN_RESOURCE_TYPE_NAME ¶
func CfnResourceVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnResourceVersion_IsCfnElement ¶
func CfnResourceVersion_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 CfnResourceVersion_IsCfnResource ¶
func CfnResourceVersion_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnResourceVersion_IsConstruct ¶
func CfnResourceVersion_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 CfnStackSet_CFN_RESOURCE_TYPE_NAME ¶
func CfnStackSet_CFN_RESOURCE_TYPE_NAME() *string
func CfnStackSet_IsCfnElement ¶
func CfnStackSet_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 CfnStackSet_IsCfnResource ¶
func CfnStackSet_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnStackSet_IsConstruct ¶
func CfnStackSet_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 CfnStack_CFN_RESOURCE_TYPE_NAME ¶
func CfnStack_CFN_RESOURCE_TYPE_NAME() *string
func CfnStack_IsCfnElement ¶
func CfnStack_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 CfnStack_IsCfnResource ¶
func CfnStack_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnStack_IsConstruct ¶
func CfnStack_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 CfnTypeActivation_CFN_RESOURCE_TYPE_NAME ¶
func CfnTypeActivation_CFN_RESOURCE_TYPE_NAME() *string
func CfnTypeActivation_IsCfnElement ¶
func CfnTypeActivation_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 CfnTypeActivation_IsCfnResource ¶
func CfnTypeActivation_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTypeActivation_IsConstruct ¶
func CfnTypeActivation_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 CfnWaitConditionHandle_CFN_RESOURCE_TYPE_NAME ¶
func CfnWaitConditionHandle_CFN_RESOURCE_TYPE_NAME() *string
func CfnWaitConditionHandle_IsCfnElement ¶
func CfnWaitConditionHandle_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 CfnWaitConditionHandle_IsCfnResource ¶
func CfnWaitConditionHandle_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnWaitConditionHandle_IsConstruct ¶
func CfnWaitConditionHandle_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 CfnWaitCondition_CFN_RESOURCE_TYPE_NAME ¶
func CfnWaitCondition_CFN_RESOURCE_TYPE_NAME() *string
func CfnWaitCondition_IsCfnElement ¶
func CfnWaitCondition_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 CfnWaitCondition_IsCfnResource ¶
func CfnWaitCondition_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnWaitCondition_IsConstruct ¶
func CfnWaitCondition_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 NewCfnCustomResource_Override ¶
func NewCfnCustomResource_Override(c CfnCustomResource, scope constructs.Construct, id *string, props *CfnCustomResourceProps)
Create a new `AWS::CloudFormation::CustomResource`.
func NewCfnGuardHook_Override ¶ added in v2.168.0
func NewCfnGuardHook_Override(c CfnGuardHook, scope constructs.Construct, id *string, props *CfnGuardHookProps)
Create a new `AWS::CloudFormation::GuardHook`.
func NewCfnHookDefaultVersion_Override ¶ added in v2.13.0
func NewCfnHookDefaultVersion_Override(c CfnHookDefaultVersion, scope constructs.Construct, id *string, props *CfnHookDefaultVersionProps)
Create a new `AWS::CloudFormation::HookDefaultVersion`.
func NewCfnHookTypeConfig_Override ¶ added in v2.13.0
func NewCfnHookTypeConfig_Override(c CfnHookTypeConfig, scope constructs.Construct, id *string, props *CfnHookTypeConfigProps)
Create a new `AWS::CloudFormation::HookTypeConfig`.
func NewCfnHookVersion_Override ¶ added in v2.13.0
func NewCfnHookVersion_Override(c CfnHookVersion, scope constructs.Construct, id *string, props *CfnHookVersionProps)
Create a new `AWS::CloudFormation::HookVersion`.
func NewCfnLambdaHook_Override ¶ added in v2.168.0
func NewCfnLambdaHook_Override(c CfnLambdaHook, scope constructs.Construct, id *string, props *CfnLambdaHookProps)
Create a new `AWS::CloudFormation::LambdaHook`.
func NewCfnMacro_Override ¶
func NewCfnMacro_Override(c CfnMacro, scope constructs.Construct, id *string, props *CfnMacroProps)
Create a new `AWS::CloudFormation::Macro`.
func NewCfnModuleDefaultVersion_Override ¶
func NewCfnModuleDefaultVersion_Override(c CfnModuleDefaultVersion, scope constructs.Construct, id *string, props *CfnModuleDefaultVersionProps)
Create a new `AWS::CloudFormation::ModuleDefaultVersion`.
func NewCfnModuleVersion_Override ¶
func NewCfnModuleVersion_Override(c CfnModuleVersion, scope constructs.Construct, id *string, props *CfnModuleVersionProps)
Create a new `AWS::CloudFormation::ModuleVersion`.
func NewCfnPublicTypeVersion_Override ¶
func NewCfnPublicTypeVersion_Override(c CfnPublicTypeVersion, scope constructs.Construct, id *string, props *CfnPublicTypeVersionProps)
Create a new `AWS::CloudFormation::PublicTypeVersion`.
func NewCfnPublisher_Override ¶
func NewCfnPublisher_Override(c CfnPublisher, scope constructs.Construct, id *string, props *CfnPublisherProps)
Create a new `AWS::CloudFormation::Publisher`.
func NewCfnResourceDefaultVersion_Override ¶
func NewCfnResourceDefaultVersion_Override(c CfnResourceDefaultVersion, scope constructs.Construct, id *string, props *CfnResourceDefaultVersionProps)
Create a new `AWS::CloudFormation::ResourceDefaultVersion`.
func NewCfnResourceVersion_Override ¶
func NewCfnResourceVersion_Override(c CfnResourceVersion, scope constructs.Construct, id *string, props *CfnResourceVersionProps)
Create a new `AWS::CloudFormation::ResourceVersion`.
func NewCfnStackSet_Override ¶
func NewCfnStackSet_Override(c CfnStackSet, scope constructs.Construct, id *string, props *CfnStackSetProps)
Create a new `AWS::CloudFormation::StackSet`.
func NewCfnStack_Override ¶
func NewCfnStack_Override(c CfnStack, scope constructs.Construct, id *string, props *CfnStackProps)
Create a new `AWS::CloudFormation::Stack`.
func NewCfnTypeActivation_Override ¶
func NewCfnTypeActivation_Override(c CfnTypeActivation, scope constructs.Construct, id *string, props *CfnTypeActivationProps)
Create a new `AWS::CloudFormation::TypeActivation`.
func NewCfnWaitConditionHandle_Override ¶
func NewCfnWaitConditionHandle_Override(c CfnWaitConditionHandle, scope constructs.Construct, id *string, props *CfnWaitConditionHandleProps)
Create a new `AWS::CloudFormation::WaitConditionHandle`.
func NewCfnWaitCondition_Override ¶
func NewCfnWaitCondition_Override(c CfnWaitCondition, scope constructs.Construct, id *string, props *CfnWaitConditionProps)
Create a new `AWS::CloudFormation::WaitCondition`.
Types ¶
type CfnCustomResource ¶
type CfnCustomResource interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawscloudformation.ICustomResourceRef
AttrId() *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
// A reference to a CustomResource resource.
CustomResourceRef() *interfacesawscloudformation.CustomResourceReference
Env() *interfaces.ResourceEnvironment
// 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 maximum time, in seconds, that can elapse before a custom resource operation times out.
ServiceTimeout() *float64
SetServiceTimeout(val *float64)
// The service token, such as an Amazon SNS topic ARN or Lambda function ARN.
ServiceToken() *string
SetServiceToken(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The `AWS::CloudFormation::CustomResource` resource creates a custom resource.
Custom resources provide a way for you to write custom provisioning logic into your CloudFormation templates and have CloudFormation run it anytime you create, update (if you changed the custom resource), or delete a stack.
For more information, see [Create custom provisioning logic with custom resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-custom-resources.html) in the *AWS CloudFormation User Guide* .
> If you use AWS PrivateLink , custom resources in the VPC must have access to CloudFormation -specific Amazon S3 buckets. Custom resources must send responses to a presigned Amazon S3 URL. If they can't send responses to Amazon S3 , CloudFormation won't receive a response and the stack operation fails. For more information, see [Access CloudFormation using an interface endpoint ( AWS PrivateLink )](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/vpc-interface-endpoints.html) in the *AWS CloudFormation User 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"
cfnCustomResource := awscdk.Aws_cloudformation.NewCfnCustomResource(this, jsii.String("MyCfnCustomResource"), &CfnCustomResourceProps{
ServiceToken: jsii.String("serviceToken"),
// the properties below are optional
ServiceTimeout: jsii.Number(123),
})
func NewCfnCustomResource ¶
func NewCfnCustomResource(scope constructs.Construct, id *string, props *CfnCustomResourceProps) CfnCustomResource
Create a new `AWS::CloudFormation::CustomResource`.
type CfnCustomResourceProps ¶
type CfnCustomResourceProps struct {
// The service token, such as an Amazon SNS topic ARN or Lambda function ARN.
//
// The service token must be from the same Region as the stack.
//
// Updates aren't supported.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-customresource.html#cfn-cloudformation-customresource-servicetoken
//
ServiceToken *string `field:"required" json:"serviceToken" yaml:"serviceToken"`
// The maximum time, in seconds, that can elapse before a custom resource operation times out.
//
// The value must be an integer from 1 to 3600. The default value is 3600 seconds (1 hour).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-customresource.html#cfn-cloudformation-customresource-servicetimeout
//
ServiceTimeout *float64 `field:"optional" json:"serviceTimeout" yaml:"serviceTimeout"`
}
Properties for defining a `CfnCustomResource`.
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"
cfnCustomResourceProps := &CfnCustomResourceProps{
ServiceToken: jsii.String("serviceToken"),
// the properties below are optional
ServiceTimeout: jsii.Number(123),
}
type CfnGuardHook ¶ added in v2.168.0
type CfnGuardHook interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawscloudformation.IGuardHookRef
// The type name alias for the Hook.
//
// This alias must be unique per account and Region.
Alias() *string
SetAlias(val *string)
// Returns the ARN of a Guard Hook.
AttrHookArn() *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
Env() *interfaces.ResourceEnvironment
// The IAM role that the Hook assumes to retrieve your Guard rules from S3 and optionally write a detailed Guard output report back.
ExecutionRole() *string
SetExecutionRole(val *string)
// Specifies how the Hook responds when rules fail their evaluation.
FailureMode() *string
SetFailureMode(val *string)
// A reference to a GuardHook resource.
GuardHookRef() *interfacesawscloudformation.GuardHookReference
// Specifies if the Hook is `ENABLED` or `DISABLED` .
HookStatus() *string
SetHookStatus(val *string)
// Specifies the name of an S3 bucket to store the Guard output report.
LogBucket() *string
SetLogBucket(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
// Specifies the S3 location of your input parameters.
Options() interface{}
SetOptions(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
// Specifies the S3 location of your Guard rules.
RuleLocation() interface{}
SetRuleLocation(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Specifies the stack level filters for the Hook.
StackFilters() interface{}
SetStackFilters(val interface{})
// Specifies the target filters for the Hook.
TargetFilters() interface{}
SetTargetFilters(val interface{})
// Specifies the list of operations the Hook is run against.
TargetOperations() *[]*string
SetTargetOperations(val *[]*string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The `AWS::CloudFormation::GuardHook` resource creates and activates a Guard Hook.
Using the Guard domain specific language (DSL), you can author Guard Hooks to evaluate your resources before allowing stack operations.
For more information, see [Guard Hooks](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/guard-hooks.html) in the *AWS CloudFormation Hooks User 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"
cfnGuardHook := awscdk.Aws_cloudformation.NewCfnGuardHook(this, jsii.String("MyCfnGuardHook"), &CfnGuardHookProps{
Alias: jsii.String("alias"),
ExecutionRole: jsii.String("executionRole"),
FailureMode: jsii.String("failureMode"),
HookStatus: jsii.String("hookStatus"),
RuleLocation: &S3LocationProperty{
Uri: jsii.String("uri"),
// the properties below are optional
VersionId: jsii.String("versionId"),
},
TargetOperations: []*string{
jsii.String("targetOperations"),
},
// the properties below are optional
LogBucket: jsii.String("logBucket"),
Options: &OptionsProperty{
InputParams: &S3LocationProperty{
Uri: jsii.String("uri"),
// the properties below are optional
VersionId: jsii.String("versionId"),
},
},
StackFilters: &StackFiltersProperty{
FilteringCriteria: jsii.String("filteringCriteria"),
// the properties below are optional
StackNames: &StackNamesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
},
StackRoles: &StackRolesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
},
},
TargetFilters: &TargetFiltersProperty{
Targets: []interface{}{
&HookTargetProperty{
Action: jsii.String("action"),
InvocationPoint: jsii.String("invocationPoint"),
TargetName: jsii.String("targetName"),
},
},
// the properties below are optional
Actions: []*string{
jsii.String("actions"),
},
InvocationPoints: []*string{
jsii.String("invocationPoints"),
},
TargetNames: []*string{
jsii.String("targetNames"),
},
},
})
func NewCfnGuardHook ¶ added in v2.168.0
func NewCfnGuardHook(scope constructs.Construct, id *string, props *CfnGuardHookProps) CfnGuardHook
Create a new `AWS::CloudFormation::GuardHook`.
type CfnGuardHookProps ¶ added in v2.168.0
type CfnGuardHookProps struct {
// The type name alias for the Hook. This alias must be unique per account and Region.
//
// The alias must be in the form `Name1::Name2::Name3` and must not begin with `AWS` . For example, `Private::Guard::MyTestHook` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-alias
//
Alias *string `field:"required" json:"alias" yaml:"alias"`
// The IAM role that the Hook assumes to retrieve your Guard rules from S3 and optionally write a detailed Guard output report back.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-executionrole
//
ExecutionRole *string `field:"required" json:"executionRole" yaml:"executionRole"`
// Specifies how the Hook responds when rules fail their evaluation.
//
// - `FAIL` : Prevents the action from proceeding. This is helpful for enforcing strict compliance or security policies.
// - `WARN` : Issues warnings to users but allows actions to continue. This is useful for non-critical validations or informational checks.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-failuremode
//
// Default: - "WARN".
//
FailureMode *string `field:"required" json:"failureMode" yaml:"failureMode"`
// Specifies if the Hook is `ENABLED` or `DISABLED` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-hookstatus
//
// Default: - "DISABLED".
//
HookStatus *string `field:"required" json:"hookStatus" yaml:"hookStatus"`
// Specifies the S3 location of your Guard rules.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-rulelocation
//
RuleLocation interface{} `field:"required" json:"ruleLocation" yaml:"ruleLocation"`
// Specifies the list of operations the Hook is run against.
//
// For more information, see [Hook targets](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-concepts.html#hook-terms-hook-target) in the *AWS CloudFormation Hooks User Guide* .
//
// Valid values: `STACK` | `RESOURCE` | `CHANGE_SET` | `CLOUD_CONTROL`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-targetoperations
//
TargetOperations *[]*string `field:"required" json:"targetOperations" yaml:"targetOperations"`
// Specifies the name of an S3 bucket to store the Guard output report.
//
// This report contains the results of your Guard rule validations.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-logbucket
//
LogBucket *string `field:"optional" json:"logBucket" yaml:"logBucket"`
// Specifies the S3 location of your input parameters.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-options
//
Options interface{} `field:"optional" json:"options" yaml:"options"`
// Specifies the stack level filters for the Hook.
//
// Example stack level filter in JSON:
//
// `"StackFilters": {"FilteringCriteria": "ALL", "StackNames": {"Exclude": [ "stack-1", "stack-2"]}}`
//
// Example stack level filter in YAML:
//
// `StackFilters: FilteringCriteria: ALL StackNames: Exclude: - stack-1 - stack-2`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-stackfilters
//
StackFilters interface{} `field:"optional" json:"stackFilters" yaml:"stackFilters"`
// Specifies the target filters for the Hook.
//
// Example target filter in JSON:
//
// `"TargetFilters": {"Actions": [ "CREATE", "UPDATE", "DELETE" ]}`
//
// Example target filter in YAML:
//
// `TargetFilters: Actions: - CREATE - UPDATE - DELETE`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-guardhook.html#cfn-cloudformation-guardhook-targetfilters
//
TargetFilters interface{} `field:"optional" json:"targetFilters" yaml:"targetFilters"`
}
Properties for defining a `CfnGuardHook`.
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"
cfnGuardHookProps := &CfnGuardHookProps{
Alias: jsii.String("alias"),
ExecutionRole: jsii.String("executionRole"),
FailureMode: jsii.String("failureMode"),
HookStatus: jsii.String("hookStatus"),
RuleLocation: &S3LocationProperty{
Uri: jsii.String("uri"),
// the properties below are optional
VersionId: jsii.String("versionId"),
},
TargetOperations: []*string{
jsii.String("targetOperations"),
},
// the properties below are optional
LogBucket: jsii.String("logBucket"),
Options: &OptionsProperty{
InputParams: &S3LocationProperty{
Uri: jsii.String("uri"),
// the properties below are optional
VersionId: jsii.String("versionId"),
},
},
StackFilters: &StackFiltersProperty{
FilteringCriteria: jsii.String("filteringCriteria"),
// the properties below are optional
StackNames: &StackNamesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
},
StackRoles: &StackRolesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
},
},
TargetFilters: &TargetFiltersProperty{
Targets: []interface{}{
&HookTargetProperty{
Action: jsii.String("action"),
InvocationPoint: jsii.String("invocationPoint"),
TargetName: jsii.String("targetName"),
},
},
// the properties below are optional
Actions: []*string{
jsii.String("actions"),
},
InvocationPoints: []*string{
jsii.String("invocationPoints"),
},
TargetNames: []*string{
jsii.String("targetNames"),
},
},
}
type CfnGuardHook_HookTargetProperty ¶ added in v2.182.0
type CfnGuardHook_HookTargetProperty struct {
// Target actions are the type of operation hooks will be executed at.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-hooktarget.html#cfn-cloudformation-guardhook-hooktarget-action
//
Action *string `field:"required" json:"action" yaml:"action"`
// Invocation points are the point in provisioning workflow where hooks will be executed.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-hooktarget.html#cfn-cloudformation-guardhook-hooktarget-invocationpoint
//
InvocationPoint *string `field:"required" json:"invocationPoint" yaml:"invocationPoint"`
// Type name of hook target.
//
// Hook targets are the destination where hooks will be invoked against.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-hooktarget.html#cfn-cloudformation-guardhook-hooktarget-targetname
//
TargetName *string `field:"required" json:"targetName" yaml:"targetName"`
}
Hook targets are the destination where hooks will be invoked against.
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"
hookTargetProperty := &HookTargetProperty{
Action: jsii.String("action"),
InvocationPoint: jsii.String("invocationPoint"),
TargetName: jsii.String("targetName"),
}
type CfnGuardHook_OptionsProperty ¶ added in v2.168.0
type CfnGuardHook_OptionsProperty struct {
// Specifies the S3 location where your input parameters are located.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-options.html#cfn-cloudformation-guardhook-options-inputparams
//
InputParams interface{} `field:"optional" json:"inputParams" yaml:"inputParams"`
}
Specifies the input parameters for a Guard Hook.
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"
optionsProperty := &OptionsProperty{
InputParams: &S3LocationProperty{
Uri: jsii.String("uri"),
// the properties below are optional
VersionId: jsii.String("versionId"),
},
}
type CfnGuardHook_S3LocationProperty ¶ added in v2.168.0
type CfnGuardHook_S3LocationProperty struct {
// Specifies the S3 path to the file that contains your Guard rules or input parameters (in the form `s3://<bucket name>/<file name>` ).
//
// For Guard rules, the object stored in S3 must have one of the following file extensions: `.guard` , `.zip` , or `.tar.gz` .
//
// For input parameters, the object stored in S3 must have one of the following file extensions: `.yaml` , `.json` , `.zip` , or `.tar.gz` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-s3location.html#cfn-cloudformation-guardhook-s3location-uri
//
Uri *string `field:"required" json:"uri" yaml:"uri"`
// For S3 buckets with versioning enabled, specifies the unique ID of the S3 object version to download your Guard rules or input parameters from.
//
// The Guard Hook downloads files from S3 every time the Hook is invoked. To prevent accidental changes or deletions, we recommend using a version when configuring your Guard Hook.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-s3location.html#cfn-cloudformation-guardhook-s3location-versionid
//
VersionId *string `field:"optional" json:"versionId" yaml:"versionId"`
}
Specifies the S3 location where your Guard rules or input parameters are located.
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"
s3LocationProperty := &S3LocationProperty{
Uri: jsii.String("uri"),
// the properties below are optional
VersionId: jsii.String("versionId"),
}
type CfnGuardHook_StackFiltersProperty ¶ added in v2.168.0
type CfnGuardHook_StackFiltersProperty struct {
// The filtering criteria.
//
// - All stack names and stack roles ( `All` ): The Hook will only be invoked when all specified filters match.
// - Any stack names and stack roles ( `Any` ): The Hook will be invoked if at least one of the specified filters match.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stackfilters.html#cfn-cloudformation-guardhook-stackfilters-filteringcriteria
//
// Default: - "ALL".
//
FilteringCriteria *string `field:"required" json:"filteringCriteria" yaml:"filteringCriteria"`
// Includes or excludes specific stacks from Hook invocations.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stackfilters.html#cfn-cloudformation-guardhook-stackfilters-stacknames
//
StackNames interface{} `field:"optional" json:"stackNames" yaml:"stackNames"`
// Includes or excludes specific stacks from Hook invocations based on their associated IAM roles.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stackfilters.html#cfn-cloudformation-guardhook-stackfilters-stackroles
//
StackRoles interface{} `field:"optional" json:"stackRoles" yaml:"stackRoles"`
}
The `StackFilters` property type specifies stack level filters for a Hook.
The `StackNames` or `StackRoles` properties are optional. However, you must specify at least one of these properties.
For more information, see [AWS CloudFormation Hooks stack level filters](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-stack-level-filtering.html) .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
stackFiltersProperty := &StackFiltersProperty{
FilteringCriteria: jsii.String("filteringCriteria"),
// the properties below are optional
StackNames: &StackNamesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
},
StackRoles: &StackRolesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
},
}
type CfnGuardHook_StackNamesProperty ¶ added in v2.168.0
type CfnGuardHook_StackNamesProperty struct {
// The stack names to exclude.
//
// All stacks except those listed here will invoke the Hook.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stacknames.html#cfn-cloudformation-guardhook-stacknames-exclude
//
Exclude *[]*string `field:"optional" json:"exclude" yaml:"exclude"`
// The stack names to include.
//
// Only the stacks specified in this list will invoke the Hook.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stacknames.html#cfn-cloudformation-guardhook-stacknames-include
//
Include *[]*string `field:"optional" json:"include" yaml:"include"`
}
Specifies the stack names for the `StackFilters` property type to include or exclude specific stacks from Hook invocations.
For more information, see [AWS CloudFormation Hooks stack level filters](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-stack-level-filtering.html) .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
stackNamesProperty := &StackNamesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
}
type CfnGuardHook_StackRolesProperty ¶ added in v2.168.0
type CfnGuardHook_StackRolesProperty struct {
// The IAM role ARNs for stacks you want to exclude.
//
// The Hook will be invoked on all stacks except those initiated by the specified roles.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stackroles.html#cfn-cloudformation-guardhook-stackroles-exclude
//
Exclude *[]*string `field:"optional" json:"exclude" yaml:"exclude"`
// The IAM role ARNs to target stacks associated with these roles.
//
// Only stack operations initiated by these roles will invoke the Hook.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-stackroles.html#cfn-cloudformation-guardhook-stackroles-include
//
Include *[]*string `field:"optional" json:"include" yaml:"include"`
}
Specifies the stack roles for the `StackFilters` property type to include or exclude specific stacks from Hook invocations based on their associated IAM roles.
For more information, see [AWS CloudFormation Hooks stack level filters](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-stack-level-filtering.html) .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
stackRolesProperty := &StackRolesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
}
type CfnGuardHook_TargetFiltersProperty ¶ added in v2.168.0
type CfnGuardHook_TargetFiltersProperty struct {
// List of hook targets.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-targetfilters.html#cfn-cloudformation-guardhook-targetfilters-targets
//
Targets interface{} `field:"required" json:"targets" yaml:"targets"`
// List of actions that the hook is going to target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-targetfilters.html#cfn-cloudformation-guardhook-targetfilters-actions
//
Actions *[]*string `field:"optional" json:"actions" yaml:"actions"`
// List of invocation points that the hook is going to target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-targetfilters.html#cfn-cloudformation-guardhook-targetfilters-invocationpoints
//
InvocationPoints *[]*string `field:"optional" json:"invocationPoints" yaml:"invocationPoints"`
// List of type names that the hook is going to target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-guardhook-targetfilters.html#cfn-cloudformation-guardhook-targetfilters-targetnames
//
TargetNames *[]*string `field:"optional" json:"targetNames" yaml:"targetNames"`
}
The `TargetFilters` property type specifies the target filters for the Hook.
For more information, see [AWS CloudFormation Hook target filters](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-target-filtering.html) .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
targetFiltersProperty := &TargetFiltersProperty{
Targets: []interface{}{
&HookTargetProperty{
Action: jsii.String("action"),
InvocationPoint: jsii.String("invocationPoint"),
TargetName: jsii.String("targetName"),
},
},
// the properties below are optional
Actions: []*string{
jsii.String("actions"),
},
InvocationPoints: []*string{
jsii.String("invocationPoints"),
},
TargetNames: []*string{
jsii.String("targetNames"),
},
}
type CfnHookDefaultVersion ¶ added in v2.13.0
type CfnHookDefaultVersion interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawscloudformation.IHookDefaultVersionRef
// The Amazon Resource Number (ARN) of the activated Hook in this account and Region.
AttrArn() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
Env() *interfaces.ResourceEnvironment
// A reference to a HookDefaultVersion resource.
HookDefaultVersionRef() *interfacesawscloudformation.HookDefaultVersionReference
// 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
// The name of the Hook.
TypeName() *string
SetTypeName(val *string)
// The version ID of the type configuration.
TypeVersionArn() *string
SetTypeVersionArn(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{}
// The version ID of the type specified.
VersionId() *string
SetVersionId(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{})
}
The `AWS::CloudFormation::HookDefaultVersion` resource specifies the default version of a Hook.
The default version of the Hook is used in CloudFormation operations for this AWS account and AWS Region .
For information about the CloudFormation registry, see [Managing extensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the *AWS CloudFormation User Guide* .
This resource type is not compatible with Guard and Lambda Hooks.
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"
cfnHookDefaultVersion := awscdk.Aws_cloudformation.NewCfnHookDefaultVersion(this, jsii.String("MyCfnHookDefaultVersion"), &CfnHookDefaultVersionProps{
TypeName: jsii.String("typeName"),
TypeVersionArn: jsii.String("typeVersionArn"),
VersionId: jsii.String("versionId"),
})
func NewCfnHookDefaultVersion ¶ added in v2.13.0
func NewCfnHookDefaultVersion(scope constructs.Construct, id *string, props *CfnHookDefaultVersionProps) CfnHookDefaultVersion
Create a new `AWS::CloudFormation::HookDefaultVersion`.
type CfnHookDefaultVersionProps ¶ added in v2.13.0
type CfnHookDefaultVersionProps struct {
// The name of the Hook.
//
// You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#cfn-cloudformation-hookdefaultversion-typename
//
TypeName *string `field:"optional" json:"typeName" yaml:"typeName"`
// The version ID of the type configuration.
//
// You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#cfn-cloudformation-hookdefaultversion-typeversionarn
//
TypeVersionArn *string `field:"optional" json:"typeVersionArn" yaml:"typeVersionArn"`
// The version ID of the type specified.
//
// You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookdefaultversion.html#cfn-cloudformation-hookdefaultversion-versionid
//
VersionId *string `field:"optional" json:"versionId" yaml:"versionId"`
}
Properties for defining a `CfnHookDefaultVersion`.
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"
cfnHookDefaultVersionProps := &CfnHookDefaultVersionProps{
TypeName: jsii.String("typeName"),
TypeVersionArn: jsii.String("typeVersionArn"),
VersionId: jsii.String("versionId"),
}
type CfnHookTypeConfig ¶ added in v2.13.0
type CfnHookTypeConfig interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawscloudformation.IHookTypeConfigRef
// The Amazon Resource Number (ARN) of the activated Hook type configuration in this account and Region.
AttrConfigurationArn() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Specifies the activated Hook type configuration, in this AWS account and AWS Region .
Configuration() *string
SetConfiguration(val *string)
// An alias by which to refer to this configuration data.
ConfigurationAlias() *string
SetConfigurationAlias(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
Env() *interfaces.ResourceEnvironment
// A reference to a HookTypeConfig resource.
HookTypeConfigRef() *interfacesawscloudformation.HookTypeConfigReference
// 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
// The Amazon Resource Number (ARN) for the Hook to set `Configuration` for.
TypeArn() *string
SetTypeArn(val *string)
// The unique name for your Hook.
TypeName() *string
SetTypeName(val *string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The `AWS::CloudFormation::HookTypeConfig` resource specifies the configuration of an activated Hook.
For information about the CloudFormation registry, see [Managing extensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the *AWS CloudFormation User 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"
cfnHookTypeConfig := awscdk.Aws_cloudformation.NewCfnHookTypeConfig(this, jsii.String("MyCfnHookTypeConfig"), &CfnHookTypeConfigProps{
Configuration: jsii.String("configuration"),
// the properties below are optional
ConfigurationAlias: jsii.String("configurationAlias"),
TypeArn: jsii.String("typeArn"),
TypeName: jsii.String("typeName"),
})
func NewCfnHookTypeConfig ¶ added in v2.13.0
func NewCfnHookTypeConfig(scope constructs.Construct, id *string, props *CfnHookTypeConfigProps) CfnHookTypeConfig
Create a new `AWS::CloudFormation::HookTypeConfig`.
type CfnHookTypeConfigProps ¶ added in v2.13.0
type CfnHookTypeConfigProps struct {
// Specifies the activated Hook type configuration, in this AWS account and AWS Region .
//
// You must specify either `TypeName` and `Configuration` or `TypeArn` and `Configuration` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-configuration
//
Configuration *string `field:"required" json:"configuration" yaml:"configuration"`
// An alias by which to refer to this configuration data.
//
// Defaults to `default` alias. Hook types currently support default configuration alias.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-configurationalias
//
// Default: - "default".
//
ConfigurationAlias *string `field:"optional" json:"configurationAlias" yaml:"configurationAlias"`
// The Amazon Resource Number (ARN) for the Hook to set `Configuration` for.
//
// You must specify either `TypeName` and `Configuration` or `TypeArn` and `Configuration` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-typearn
//
TypeArn *string `field:"optional" json:"typeArn" yaml:"typeArn"`
// The unique name for your Hook.
//
// Specifies a three-part namespace for your Hook, with a recommended pattern of `Organization::Service::Hook` .
//
// You must specify either `TypeName` and `Configuration` or `TypeArn` and `Configuration` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-typename
//
TypeName *string `field:"optional" json:"typeName" yaml:"typeName"`
}
Properties for defining a `CfnHookTypeConfig`.
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"
cfnHookTypeConfigProps := &CfnHookTypeConfigProps{
Configuration: jsii.String("configuration"),
// the properties below are optional
ConfigurationAlias: jsii.String("configurationAlias"),
TypeArn: jsii.String("typeArn"),
TypeName: jsii.String("typeName"),
}
type CfnHookVersion ¶ added in v2.13.0
type CfnHookVersion interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawscloudformation.IHookVersionRef
// The Amazon Resource Name (ARN) of the Hook.
AttrArn() *string
// Whether the specified Hook version is set as the default version.
AttrIsDefaultVersion() awscdk.IResolvable
// The Amazon Resource Number (ARN) assigned to this version of the Hook.
AttrTypeArn() *string
// The ID of this version of the Hook.
AttrVersionId() *string
// The visibility level that determines who can see and use this Hook in CloudFormation operations:.
//
// - `PRIVATE` : The Hook is only visible and usable within the account where it was registered. CloudFormation automatically marks any Hooks you register as `PRIVATE` .
// - `PUBLIC` : The Hook is publicly visible and usable within any AWS account.
AttrVisibility() *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
Env() *interfaces.ResourceEnvironment
// The Amazon Resource Name (ARN) of the task execution role that grants the Hook permission.
ExecutionRoleArn() *string
SetExecutionRoleArn(val *string)
// A reference to a HookVersion resource.
HookVersionRef() *interfacesawscloudformation.HookVersionReference
// Contains logging configuration information for an extension.
LoggingConfig() interface{}
SetLoggingConfig(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 URL to the Amazon S3 bucket for the Hook project package that contains the necessary files for the Hook you want to register.
SchemaHandlerPackage() *string
SetSchemaHandlerPackage(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 unique name for your Hook.
TypeName() *string
SetTypeName(val *string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The `AWS::CloudFormation::HookVersion` resource publishes new or first version of a Hook to the CloudFormation registry.
For information about the CloudFormation registry, see [Managing extensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the *AWS CloudFormation User Guide* .
This resource type is not compatible with Guard and Lambda Hooks.
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"
cfnHookVersion := awscdk.Aws_cloudformation.NewCfnHookVersion(this, jsii.String("MyCfnHookVersion"), &CfnHookVersionProps{
SchemaHandlerPackage: jsii.String("schemaHandlerPackage"),
TypeName: jsii.String("typeName"),
// the properties below are optional
ExecutionRoleArn: jsii.String("executionRoleArn"),
LoggingConfig: &LoggingConfigProperty{
LogGroupName: jsii.String("logGroupName"),
LogRoleArn: jsii.String("logRoleArn"),
},
})
func NewCfnHookVersion ¶ added in v2.13.0
func NewCfnHookVersion(scope constructs.Construct, id *string, props *CfnHookVersionProps) CfnHookVersion
Create a new `AWS::CloudFormation::HookVersion`.
type CfnHookVersionProps ¶ added in v2.13.0
type CfnHookVersionProps struct {
// A URL to the Amazon S3 bucket for the Hook project package that contains the necessary files for the Hook you want to register.
//
// For information on generating a schema handler package, see [Modeling custom CloudFormation Hooks](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-model.html) in the *AWS CloudFormation Hooks User Guide* .
//
// > To register the Hook, you must have `s3:GetObject` permissions to access the S3 objects.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-schemahandlerpackage
//
SchemaHandlerPackage *string `field:"required" json:"schemaHandlerPackage" yaml:"schemaHandlerPackage"`
// The unique name for your Hook.
//
// Specifies a three-part namespace for your Hook, with a recommended pattern of `Organization::Service::Hook` .
//
// > The following organization namespaces are reserved and can't be used in your Hook type names:
// >
// > - `Alexa`
// > - `AMZN`
// > - `Amazon`
// > - `ASK`
// > - `AWS`
// > - `Custom`
// > - `Dev`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-typename
//
TypeName *string `field:"required" json:"typeName" yaml:"typeName"`
// The Amazon Resource Name (ARN) of the task execution role that grants the Hook permission.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-executionrolearn
//
ExecutionRoleArn *string `field:"optional" json:"executionRoleArn" yaml:"executionRoleArn"`
// Contains logging configuration information for an extension.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-loggingconfig
//
LoggingConfig interface{} `field:"optional" json:"loggingConfig" yaml:"loggingConfig"`
}
Properties for defining a `CfnHookVersion`.
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"
cfnHookVersionProps := &CfnHookVersionProps{
SchemaHandlerPackage: jsii.String("schemaHandlerPackage"),
TypeName: jsii.String("typeName"),
// the properties below are optional
ExecutionRoleArn: jsii.String("executionRoleArn"),
LoggingConfig: &LoggingConfigProperty{
LogGroupName: jsii.String("logGroupName"),
LogRoleArn: jsii.String("logRoleArn"),
},
}
type CfnHookVersion_LoggingConfigProperty ¶ added in v2.13.0
type CfnHookVersion_LoggingConfigProperty struct {
// The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the extension's handlers.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-hookversion-loggingconfig.html#cfn-cloudformation-hookversion-loggingconfig-loggroupname
//
LogGroupName *string `field:"optional" json:"logGroupName" yaml:"logGroupName"`
// The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries to CloudWatch Logs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-hookversion-loggingconfig.html#cfn-cloudformation-hookversion-loggingconfig-logrolearn
//
LogRoleArn *string `field:"optional" json:"logRoleArn" yaml:"logRoleArn"`
}
The `LoggingConfig` property type specifies logging configuration information for an extension.
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"
loggingConfigProperty := &LoggingConfigProperty{
LogGroupName: jsii.String("logGroupName"),
LogRoleArn: jsii.String("logRoleArn"),
}
type CfnLambdaHook ¶ added in v2.168.0
type CfnLambdaHook interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawscloudformation.ILambdaHookRef
// The type name alias for the Hook.
//
// This alias must be unique per account and Region.
Alias() *string
SetAlias(val *string)
// Returns the ARN of a Lambda Hook.
AttrHookArn() *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
Env() *interfaces.ResourceEnvironment
// The IAM role that the Hook assumes to invoke your Lambda function.
ExecutionRole() *string
SetExecutionRole(val *string)
// Specifies how the Hook responds when the Lambda function invoked by the Hook returns a `FAILED` response.
FailureMode() *string
SetFailureMode(val *string)
// Specifies if the Hook is `ENABLED` or `DISABLED` .
HookStatus() *string
SetHookStatus(val *string)
// Specifies the Lambda function for the Hook.
//
// You can use:.
LambdaFunction() *string
SetLambdaFunction(val *string)
// A reference to a LambdaHook resource.
LambdaHookRef() *interfacesawscloudformation.LambdaHookReference
// 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
// Specifies the stack level filters for the Hook.
StackFilters() interface{}
SetStackFilters(val interface{})
// Specifies the target filters for the Hook.
TargetFilters() interface{}
SetTargetFilters(val interface{})
// Specifies the list of operations the Hook is run against.
TargetOperations() *[]*string
SetTargetOperations(val *[]*string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The `AWS::CloudFormation::LambdaHook` resource creates and activates a Lambda Hook.
You can use a Lambda Hook to evaluate your resources before allowing stack operations. This resource forwards requests for resource evaluation to a Lambda function.
For more information, see [Lambda Hooks](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/lambda-hooks.html) in the *AWS CloudFormation Hooks User 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"
cfnLambdaHook := awscdk.Aws_cloudformation.NewCfnLambdaHook(this, jsii.String("MyCfnLambdaHook"), &CfnLambdaHookProps{
Alias: jsii.String("alias"),
ExecutionRole: jsii.String("executionRole"),
FailureMode: jsii.String("failureMode"),
HookStatus: jsii.String("hookStatus"),
LambdaFunction: jsii.String("lambdaFunction"),
TargetOperations: []*string{
jsii.String("targetOperations"),
},
// the properties below are optional
StackFilters: &StackFiltersProperty{
FilteringCriteria: jsii.String("filteringCriteria"),
// the properties below are optional
StackNames: &StackNamesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
},
StackRoles: &StackRolesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
},
},
TargetFilters: &TargetFiltersProperty{
Targets: []interface{}{
&HookTargetProperty{
Action: jsii.String("action"),
InvocationPoint: jsii.String("invocationPoint"),
TargetName: jsii.String("targetName"),
},
},
// the properties below are optional
Actions: []*string{
jsii.String("actions"),
},
InvocationPoints: []*string{
jsii.String("invocationPoints"),
},
TargetNames: []*string{
jsii.String("targetNames"),
},
},
})
func NewCfnLambdaHook ¶ added in v2.168.0
func NewCfnLambdaHook(scope constructs.Construct, id *string, props *CfnLambdaHookProps) CfnLambdaHook
Create a new `AWS::CloudFormation::LambdaHook`.
type CfnLambdaHookProps ¶ added in v2.168.0
type CfnLambdaHookProps struct {
// The type name alias for the Hook. This alias must be unique per account and Region.
//
// The alias must be in the form `Name1::Name2::Name3` and must not begin with `AWS` . For example, `Private::Lambda::MyTestHook` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html#cfn-cloudformation-lambdahook-alias
//
Alias *string `field:"required" json:"alias" yaml:"alias"`
// The IAM role that the Hook assumes to invoke your Lambda function.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html#cfn-cloudformation-lambdahook-executionrole
//
ExecutionRole *string `field:"required" json:"executionRole" yaml:"executionRole"`
// Specifies how the Hook responds when the Lambda function invoked by the Hook returns a `FAILED` response.
//
// - `FAIL` : Prevents the action from proceeding. This is helpful for enforcing strict compliance or security policies.
// - `WARN` : Issues warnings to users but allows actions to continue. This is useful for non-critical validations or informational checks.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html#cfn-cloudformation-lambdahook-failuremode
//
FailureMode *string `field:"required" json:"failureMode" yaml:"failureMode"`
// Specifies if the Hook is `ENABLED` or `DISABLED` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html#cfn-cloudformation-lambdahook-hookstatus
//
// Default: - "ENABLED".
//
HookStatus *string `field:"required" json:"hookStatus" yaml:"hookStatus"`
// Specifies the Lambda function for the Hook. You can use:.
//
// - The full Amazon Resource Name (ARN) without a suffix.
// - A qualified ARN with a version or alias suffix.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html#cfn-cloudformation-lambdahook-lambdafunction
//
LambdaFunction *string `field:"required" json:"lambdaFunction" yaml:"lambdaFunction"`
// Specifies the list of operations the Hook is run against.
//
// For more information, see [Hook targets](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-concepts.html#hook-terms-hook-target) in the *AWS CloudFormation Hooks User Guide* .
//
// Valid values: `STACK` | `RESOURCE` | `CHANGE_SET` | `CLOUD_CONTROL`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html#cfn-cloudformation-lambdahook-targetoperations
//
TargetOperations *[]*string `field:"required" json:"targetOperations" yaml:"targetOperations"`
// Specifies the stack level filters for the Hook.
//
// Example stack level filter in JSON:
//
// `"StackFilters": {"FilteringCriteria": "ALL", "StackNames": {"Exclude": [ "stack-1", "stack-2"]}}`
//
// Example stack level filter in YAML:
//
// `StackFilters: FilteringCriteria: ALL StackNames: Exclude: - stack-1 - stack-2`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html#cfn-cloudformation-lambdahook-stackfilters
//
StackFilters interface{} `field:"optional" json:"stackFilters" yaml:"stackFilters"`
// Specifies the target filters for the Hook.
//
// Example target filter in JSON:
//
// `"TargetFilters": {"Actions": [ "CREATE", "UPDATE", "DELETE" ]}`
//
// Example target filter in YAML:
//
// `TargetFilters: Actions: - CREATE - UPDATE - DELETE`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html#cfn-cloudformation-lambdahook-targetfilters
//
TargetFilters interface{} `field:"optional" json:"targetFilters" yaml:"targetFilters"`
}
Properties for defining a `CfnLambdaHook`.
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"
cfnLambdaHookProps := &CfnLambdaHookProps{
Alias: jsii.String("alias"),
ExecutionRole: jsii.String("executionRole"),
FailureMode: jsii.String("failureMode"),
HookStatus: jsii.String("hookStatus"),
LambdaFunction: jsii.String("lambdaFunction"),
TargetOperations: []*string{
jsii.String("targetOperations"),
},
// the properties below are optional
StackFilters: &StackFiltersProperty{
FilteringCriteria: jsii.String("filteringCriteria"),
// the properties below are optional
StackNames: &StackNamesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
},
StackRoles: &StackRolesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
},
},
TargetFilters: &TargetFiltersProperty{
Targets: []interface{}{
&HookTargetProperty{
Action: jsii.String("action"),
InvocationPoint: jsii.String("invocationPoint"),
TargetName: jsii.String("targetName"),
},
},
// the properties below are optional
Actions: []*string{
jsii.String("actions"),
},
InvocationPoints: []*string{
jsii.String("invocationPoints"),
},
TargetNames: []*string{
jsii.String("targetNames"),
},
},
}
type CfnLambdaHook_HookTargetProperty ¶ added in v2.182.0
type CfnLambdaHook_HookTargetProperty struct {
// Target actions are the type of operation hooks will be executed at.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-hooktarget.html#cfn-cloudformation-lambdahook-hooktarget-action
//
Action *string `field:"required" json:"action" yaml:"action"`
// Invocation points are the point in provisioning workflow where hooks will be executed.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-hooktarget.html#cfn-cloudformation-lambdahook-hooktarget-invocationpoint
//
InvocationPoint *string `field:"required" json:"invocationPoint" yaml:"invocationPoint"`
// Type name of hook target.
//
// Hook targets are the destination where hooks will be invoked against.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-hooktarget.html#cfn-cloudformation-lambdahook-hooktarget-targetname
//
TargetName *string `field:"required" json:"targetName" yaml:"targetName"`
}
Hook targets are the destination where hooks will be invoked against.
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"
hookTargetProperty := &HookTargetProperty{
Action: jsii.String("action"),
InvocationPoint: jsii.String("invocationPoint"),
TargetName: jsii.String("targetName"),
}
type CfnLambdaHook_StackFiltersProperty ¶ added in v2.168.0
type CfnLambdaHook_StackFiltersProperty struct {
// The filtering criteria.
//
// - All stack names and stack roles ( `All` ): The Hook will only be invoked when all specified filters match.
// - Any stack names and stack roles ( `Any` ): The Hook will be invoked if at least one of the specified filters match.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-stackfilters.html#cfn-cloudformation-lambdahook-stackfilters-filteringcriteria
//
// Default: - "ALL".
//
FilteringCriteria *string `field:"required" json:"filteringCriteria" yaml:"filteringCriteria"`
// Includes or excludes specific stacks from Hook invocations.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-stackfilters.html#cfn-cloudformation-lambdahook-stackfilters-stacknames
//
StackNames interface{} `field:"optional" json:"stackNames" yaml:"stackNames"`
// Includes or excludes specific stacks from Hook invocations based on their associated IAM roles.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-stackfilters.html#cfn-cloudformation-lambdahook-stackfilters-stackroles
//
StackRoles interface{} `field:"optional" json:"stackRoles" yaml:"stackRoles"`
}
The `StackFilters` property type specifies stack level filters for a Hook.
The `StackNames` or `StackRoles` properties are optional. However, you must specify at least one of these properties.
For more information, see [AWS CloudFormation Hooks stack level filters](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-stack-level-filtering.html) .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
stackFiltersProperty := &StackFiltersProperty{
FilteringCriteria: jsii.String("filteringCriteria"),
// the properties below are optional
StackNames: &StackNamesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
},
StackRoles: &StackRolesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
},
}
type CfnLambdaHook_StackNamesProperty ¶ added in v2.168.0
type CfnLambdaHook_StackNamesProperty struct {
// The stack names to exclude.
//
// All stacks except those listed here will invoke the Hook.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-stacknames.html#cfn-cloudformation-lambdahook-stacknames-exclude
//
Exclude *[]*string `field:"optional" json:"exclude" yaml:"exclude"`
// The stack names to include.
//
// Only the stacks specified in this list will invoke the Hook.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-stacknames.html#cfn-cloudformation-lambdahook-stacknames-include
//
Include *[]*string `field:"optional" json:"include" yaml:"include"`
}
Specifies the stack names for the `StackFilters` property type to include or exclude specific stacks from Hook invocations.
For more information, see [AWS CloudFormation Hooks stack level filters](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-stack-level-filtering.html) .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
stackNamesProperty := &StackNamesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
}
type CfnLambdaHook_StackRolesProperty ¶ added in v2.168.0
type CfnLambdaHook_StackRolesProperty struct {
// The IAM role ARNs for stacks you want to exclude.
//
// The Hook will be invoked on all stacks except those initiated by the specified roles.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-stackroles.html#cfn-cloudformation-lambdahook-stackroles-exclude
//
Exclude *[]*string `field:"optional" json:"exclude" yaml:"exclude"`
// The IAM role ARNs to target stacks associated with these roles.
//
// Only stack operations initiated by these roles will invoke the Hook.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-stackroles.html#cfn-cloudformation-lambdahook-stackroles-include
//
Include *[]*string `field:"optional" json:"include" yaml:"include"`
}
Specifies the stack roles for the `StackFilters` property type to include or exclude specific stacks from Hook invocations based on their associated IAM roles.
For more information, see [AWS CloudFormation Hooks stack level filters](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-stack-level-filtering.html) .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
stackRolesProperty := &StackRolesProperty{
Exclude: []*string{
jsii.String("exclude"),
},
Include: []*string{
jsii.String("include"),
},
}
type CfnLambdaHook_TargetFiltersProperty ¶ added in v2.168.0
type CfnLambdaHook_TargetFiltersProperty struct {
// List of hook targets.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-targetfilters.html#cfn-cloudformation-lambdahook-targetfilters-targets
//
Targets interface{} `field:"required" json:"targets" yaml:"targets"`
// List of actions that the hook is going to target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-targetfilters.html#cfn-cloudformation-lambdahook-targetfilters-actions
//
Actions *[]*string `field:"optional" json:"actions" yaml:"actions"`
// List of invocation points that the hook is going to target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-targetfilters.html#cfn-cloudformation-lambdahook-targetfilters-invocationpoints
//
InvocationPoints *[]*string `field:"optional" json:"invocationPoints" yaml:"invocationPoints"`
// List of type names that the hook is going to target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-lambdahook-targetfilters.html#cfn-cloudformation-lambdahook-targetfilters-targetnames
//
TargetNames *[]*string `field:"optional" json:"targetNames" yaml:"targetNames"`
}
The `TargetFilters` property type specifies the target filters for the Hook.
For more information, see [AWS CloudFormation Hook target filters](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-target-filtering.html) .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
targetFiltersProperty := &TargetFiltersProperty{
Targets: []interface{}{
&HookTargetProperty{
Action: jsii.String("action"),
InvocationPoint: jsii.String("invocationPoint"),
TargetName: jsii.String("targetName"),
},
},
// the properties below are optional
Actions: []*string{
jsii.String("actions"),
},
InvocationPoints: []*string{
jsii.String("invocationPoints"),
},
TargetNames: []*string{
jsii.String("targetNames"),
},
}
type CfnMacro ¶
type CfnMacro interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawscloudformation.IMacroRef
// Returns a unique identifier for the resource.
AttrId() *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
// A description of the macro.
Description() *string
SetDescription(val *string)
Env() *interfaces.ResourceEnvironment
// The Amazon Resource Name (ARN) of the underlying Lambda function that you want CloudFormation to invoke when the macro is run.
FunctionName() *string
SetFunctionName(val *string)
// The CloudWatch Logs group to which CloudFormation sends error logging information when invoking the macro's underlying Lambda function.
LogGroupName() *string
SetLogGroupName(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 ARN of the role CloudFormation should assume when sending log entries to CloudWatch Logs .
LogRoleArn() *string
SetLogRoleArn(val *string)
// A reference to a Macro resource.
MacroRef() *interfacesawscloudformation.MacroReference
// The name of the macro.
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
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The `AWS::CloudFormation::Macro` resource is a CloudFormation resource type that creates a CloudFormation macro to perform custom processing on CloudFormation templates.
For more information, see [Perform custom processing on CloudFormation templates with template macros](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html) in the *AWS CloudFormation User 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"
cfnMacro := awscdk.Aws_cloudformation.NewCfnMacro(this, jsii.String("MyCfnMacro"), &CfnMacroProps{
FunctionName: jsii.String("functionName"),
Name: jsii.String("name"),
// the properties below are optional
Description: jsii.String("description"),
LogGroupName: jsii.String("logGroupName"),
LogRoleArn: jsii.String("logRoleArn"),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html
func NewCfnMacro ¶
func NewCfnMacro(scope constructs.Construct, id *string, props *CfnMacroProps) CfnMacro
Create a new `AWS::CloudFormation::Macro`.
type CfnMacroProps ¶
type CfnMacroProps struct {
// The Amazon Resource Name (ARN) of the underlying Lambda function that you want CloudFormation to invoke when the macro is run.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-functionname
//
FunctionName *string `field:"required" json:"functionName" yaml:"functionName"`
// The name of the macro.
//
// The name of the macro must be unique across all macros in the account.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// A description of the macro.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The CloudWatch Logs group to which CloudFormation sends error logging information when invoking the macro's underlying Lambda function.
//
// This will be an existing CloudWatch Logs LogGroup. Neither CloudFormation or Lambda will create the group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-loggroupname
//
LogGroupName *string `field:"optional" json:"logGroupName" yaml:"logGroupName"`
// The ARN of the role CloudFormation should assume when sending log entries to CloudWatch Logs .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html#cfn-cloudformation-macro-logrolearn
//
LogRoleArn *string `field:"optional" json:"logRoleArn" yaml:"logRoleArn"`
}
Properties for defining a `CfnMacro`.
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"
cfnMacroProps := &CfnMacroProps{
FunctionName: jsii.String("functionName"),
Name: jsii.String("name"),
// the properties below are optional
Description: jsii.String("description"),
LogGroupName: jsii.String("logGroupName"),
LogRoleArn: jsii.String("logRoleArn"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-macro.html
type CfnModuleDefaultVersion ¶
type CfnModuleDefaultVersion interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawscloudformation.IModuleDefaultVersionRef
// The Amazon Resource Name (ARN) of the module version to set as the default version.
Arn() *string
SetArn(val *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
Env() *interfaces.ResourceEnvironment
// 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
// A reference to a ModuleDefaultVersion resource.
ModuleDefaultVersionRef() *interfacesawscloudformation.ModuleDefaultVersionReference
// The name of the module.
ModuleName() *string
SetModuleName(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
// 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 ID for the specific version of the module.
VersionId() *string
SetVersionId(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{})
}
Specifies the default version of a module.
The default version of the module will be used in CloudFormation operations for this account and Region.
For more information, see [Create reusable resource configurations that can be included across templates with CloudFormation modules](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html) in the *AWS CloudFormation User Guide* .
For information about the CloudFormation registry, see [Managing extensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the *AWS CloudFormation User 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"
cfnModuleDefaultVersion := awscdk.Aws_cloudformation.NewCfnModuleDefaultVersion(this, jsii.String("MyCfnModuleDefaultVersion"), &CfnModuleDefaultVersionProps{
Arn: jsii.String("arn"),
ModuleName: jsii.String("moduleName"),
VersionId: jsii.String("versionId"),
})
func NewCfnModuleDefaultVersion ¶
func NewCfnModuleDefaultVersion(scope constructs.Construct, id *string, props *CfnModuleDefaultVersionProps) CfnModuleDefaultVersion
Create a new `AWS::CloudFormation::ModuleDefaultVersion`.
type CfnModuleDefaultVersionProps ¶
type CfnModuleDefaultVersionProps struct {
// The Amazon Resource Name (ARN) of the module version to set as the default version.
//
// Conditional: You must specify either `Arn` , or `ModuleName` and `VersionId` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-arn
//
Arn *string `field:"optional" json:"arn" yaml:"arn"`
// The name of the module.
//
// Conditional: You must specify either `Arn` , or `ModuleName` and `VersionId` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-modulename
//
ModuleName *string `field:"optional" json:"moduleName" yaml:"moduleName"`
// The ID for the specific version of the module.
//
// Conditional: You must specify either `Arn` , or `ModuleName` and `VersionId` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduledefaultversion.html#cfn-cloudformation-moduledefaultversion-versionid
//
VersionId *string `field:"optional" json:"versionId" yaml:"versionId"`
}
Properties for defining a `CfnModuleDefaultVersion`.
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"
cfnModuleDefaultVersionProps := &CfnModuleDefaultVersionProps{
Arn: jsii.String("arn"),
ModuleName: jsii.String("moduleName"),
VersionId: jsii.String("versionId"),
}
type CfnModuleVersion ¶
type CfnModuleVersion interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawscloudformation.IModuleVersionRef
// The Amazon Resource Name (ARN) of the module.
AttrArn() *string
// The description of the module.
AttrDescription() *string
// The URL of a page providing detailed documentation for this module.
AttrDocumentationUrl() *string
// Whether the specified module version is set as the default version.
//
// This applies only to private extensions you have registered in your account, and extensions published by AWS . For public third-party extensions, whether they are activated in your account, CloudFormation returns `null` .
AttrIsDefaultVersion() awscdk.IResolvable
// The schema that defines the module.
AttrSchema() *string
// When the specified private module version was registered or activated in your account.
AttrTimeCreated() *string
// The ID of this version of the module.
AttrVersionId() *string
// The visibility level that determines who can see and use this module in CloudFormation operations:.
//
// - `PRIVATE` : The module is only visible and usable within the account where it was registered. CloudFormation automatically marks any modules you register as `PRIVATE` .
// - `PUBLIC` : The module is publicly visible and usable within any AWS account.
AttrVisibility() *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
Env() *interfaces.ResourceEnvironment
// 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 module being registered.
ModuleName() *string
SetModuleName(val *string)
// A URL to the S3 bucket for the package that contains the template fragment and schema files for the module version to register.
ModulePackage() *string
SetModulePackage(val *string)
// A reference to a ModuleVersion resource.
ModuleVersionRef() *interfacesawscloudformation.ModuleVersionReference
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The `AWS::CloudFormation::ModuleVersion` resource registers the specified version of the module with the CloudFormation registry.
Registering a module makes it available for use in CloudFormation templates in your AWS account and Region.
For more information, see [Create reusable resource configurations that can be included across templates with CloudFormation modules](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html) in the *CloudFormation User Guide* .
For information about the CloudFormation registry, see [Managing extensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the *AWS CloudFormation User 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"
cfnModuleVersion := awscdk.Aws_cloudformation.NewCfnModuleVersion(this, jsii.String("MyCfnModuleVersion"), &CfnModuleVersionProps{
ModuleName: jsii.String("moduleName"),
ModulePackage: jsii.String("modulePackage"),
})
func NewCfnModuleVersion ¶
func NewCfnModuleVersion(scope constructs.Construct, id *string, props *CfnModuleVersionProps) CfnModuleVersion
Create a new `AWS::CloudFormation::ModuleVersion`.
type CfnModuleVersionProps ¶
type CfnModuleVersionProps struct {
// The name of the module being registered.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#cfn-cloudformation-moduleversion-modulename
//
ModuleName *string `field:"required" json:"moduleName" yaml:"moduleName"`
// A URL to the S3 bucket for the package that contains the template fragment and schema files for the module version to register.
//
// For more information, see [Module structure and requirements](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/modules-structure.html) in the *AWS CloudFormation Command Line Interface (CLI) User Guide* .
//
// > To register the module version, you must have `s3:GetObject` permissions to access the S3 objects.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-moduleversion.html#cfn-cloudformation-moduleversion-modulepackage
//
ModulePackage *string `field:"required" json:"modulePackage" yaml:"modulePackage"`
}
Properties for defining a `CfnModuleVersion`.
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"
cfnModuleVersionProps := &CfnModuleVersionProps{
ModuleName: jsii.String("moduleName"),
ModulePackage: jsii.String("modulePackage"),
}
type CfnPublicTypeVersion ¶
type CfnPublicTypeVersion interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawscloudformation.IPublicTypeVersionRef
// The Amazon Resource Number (ARN) of the extension.
Arn() *string
SetArn(val *string)
// The Amazon Resource Number (ARN) assigned to the public extension upon publication.
AttrPublicTypeArn() *string
// The publisher ID of the extension publisher.
//
// This applies only to public third-party extensions. For private registered extensions, and extensions provided by AWS , CloudFormation returns `null` .
AttrPublisherId() *string
// The Amazon Resource Number (ARN) assigned to this version of the extension.
AttrTypeVersionArn() *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
Env() *interfaces.ResourceEnvironment
// The S3 bucket to which CloudFormation delivers the contract test execution logs.
LogDeliveryBucket() *string
SetLogDeliveryBucket(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// A reference to a PublicTypeVersion resource.
PublicTypeVersionRef() *interfacesawscloudformation.PublicTypeVersionReference
// The version number to assign to this version of the extension.
PublicVersionNumber() *string
SetPublicVersionNumber(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 type of the extension to test.
Type() *string
SetType(val *string)
// The name of the extension to test.
TypeName() *string
SetTypeName(val *string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The `AWS::CloudFormation::PublicTypeVersion` resource tests and publishes a registered extension as a public, third-party extension.
CloudFormation first tests the extension to make sure it meets all necessary requirements for being published in the CloudFormation registry. If it does, CloudFormation then publishes it to the registry as a public third-party extension in this Region. Public extensions are available for use by all CloudFormation users.
- For resource types, testing includes passing all contracts tests defined for the type. - For modules, testing includes determining if the module's model meets all necessary requirements.
For more information, see [Testing your public extension prior to publishing](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-testing) in the *AWS CloudFormation Command Line Interface (CLI) User Guide* .
If you don't specify a version, CloudFormation uses the default version of the extension in your account and Region for testing.
To perform testing, CloudFormation assumes the execution role specified when the type was registered.
An extension must have a test status of `PASSED` before it can be published. For more information, see [Publishing extensions to make them available for public use](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html) in the *AWS CloudFormation Command Line Interface (CLI) User 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"
cfnPublicTypeVersion := awscdk.Aws_cloudformation.NewCfnPublicTypeVersion(this, jsii.String("MyCfnPublicTypeVersion"), &CfnPublicTypeVersionProps{
Arn: jsii.String("arn"),
LogDeliveryBucket: jsii.String("logDeliveryBucket"),
PublicVersionNumber: jsii.String("publicVersionNumber"),
Type: jsii.String("type"),
TypeName: jsii.String("typeName"),
})
func NewCfnPublicTypeVersion ¶
func NewCfnPublicTypeVersion(scope constructs.Construct, id *string, props *CfnPublicTypeVersionProps) CfnPublicTypeVersion
Create a new `AWS::CloudFormation::PublicTypeVersion`.
type CfnPublicTypeVersionProps ¶
type CfnPublicTypeVersionProps struct {
// The Amazon Resource Number (ARN) of the extension.
//
// Conditional: You must specify `Arn` , or `TypeName` and `Type` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-arn
//
Arn *string `field:"optional" json:"arn" yaml:"arn"`
// The S3 bucket to which CloudFormation delivers the contract test execution logs.
//
// CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of `PASSED` or `FAILED` .
//
// The user initiating the stack operation must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:
//
// - s3:GetObject
// - s3:PutObject.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-logdeliverybucket
//
LogDeliveryBucket *string `field:"optional" json:"logDeliveryBucket" yaml:"logDeliveryBucket"`
// The version number to assign to this version of the extension.
//
// Use the following format, and adhere to semantic versioning when assigning a version number to your extension:
//
// `MAJOR.MINOR.PATCH`
//
// For more information, see [Semantic Versioning 2.0.0](https://docs.aws.amazon.com/https://semver.org/) .
//
// If you don't specify a version number, CloudFormation increments the version number by one minor version release.
//
// You cannot specify a version number the first time you publish a type. CloudFormation automatically sets the first version number to be `1.0.0` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-publicversionnumber
//
PublicVersionNumber *string `field:"optional" json:"publicVersionNumber" yaml:"publicVersionNumber"`
// The type of the extension to test.
//
// Conditional: You must specify `Arn` , or `TypeName` and `Type` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-type
//
Type *string `field:"optional" json:"type" yaml:"type"`
// The name of the extension to test.
//
// Conditional: You must specify `Arn` , or `TypeName` and `Type` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-typename
//
TypeName *string `field:"optional" json:"typeName" yaml:"typeName"`
}
Properties for defining a `CfnPublicTypeVersion`.
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"
cfnPublicTypeVersionProps := &CfnPublicTypeVersionProps{
Arn: jsii.String("arn"),
LogDeliveryBucket: jsii.String("logDeliveryBucket"),
PublicVersionNumber: jsii.String("publicVersionNumber"),
Type: jsii.String("type"),
TypeName: jsii.String("typeName"),
}
type CfnPublisher ¶
type CfnPublisher interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawscloudformation.IPublisherRef
// Whether you accept the [Terms and Conditions](https://docs.aws.amazon.com/https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf) for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to register to publish public extensions to the CloudFormation registry.
AcceptTermsAndConditions() interface{}
SetAcceptTermsAndConditions(val interface{})
// The type of account used as the identity provider when registering this publisher with CloudFormation.
AttrIdentityProvider() *string
// The ID of the extension publisher.
AttrPublisherId() *string
// The URL to the publisher's profile with the identity provider.
AttrPublisherProfile() *string
// Whether the publisher is verified.
//
// Currently, all registered publishers are verified.
AttrPublisherStatus() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account.
ConnectionArn() *string
SetConnectionArn(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
Env() *interfaces.ResourceEnvironment
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// A reference to a Publisher resource.
PublisherRef() *interfacesawscloudformation.PublisherReference
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The `AWS::CloudFormation::Publisher` resource registers your account as a publisher of public extensions in the CloudFormation registry.
Public extensions are available for use by all CloudFormation users.
For information on requirements for registering as a public extension publisher, see [Publishing extensions to make them available for public use](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.htm) in the *AWS CloudFormation Command Line Interface (CLI) User 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"
cfnPublisher := awscdk.Aws_cloudformation.NewCfnPublisher(this, jsii.String("MyCfnPublisher"), &CfnPublisherProps{
AcceptTermsAndConditions: jsii.Boolean(false),
// the properties below are optional
ConnectionArn: jsii.String("connectionArn"),
})
func NewCfnPublisher ¶
func NewCfnPublisher(scope constructs.Construct, id *string, props *CfnPublisherProps) CfnPublisher
Create a new `AWS::CloudFormation::Publisher`.
type CfnPublisherProps ¶
type CfnPublisherProps struct {
// Whether you accept the [Terms and Conditions](https://docs.aws.amazon.com/https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf) for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to register to publish public extensions to the CloudFormation registry.
//
// The default is `false` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html#cfn-cloudformation-publisher-accepttermsandconditions
//
AcceptTermsAndConditions interface{} `field:"required" json:"acceptTermsAndConditions" yaml:"acceptTermsAndConditions"`
// If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account.
//
// For more information, see [Prerequisite: Registering your account to publish CloudFormation extensions](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs) in the *AWS CloudFormation Command Line Interface (CLI) User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publisher.html#cfn-cloudformation-publisher-connectionarn
//
ConnectionArn *string `field:"optional" json:"connectionArn" yaml:"connectionArn"`
}
Properties for defining a `CfnPublisher`.
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"
cfnPublisherProps := &CfnPublisherProps{
AcceptTermsAndConditions: jsii.Boolean(false),
// the properties below are optional
ConnectionArn: jsii.String("connectionArn"),
}
type CfnResourceDefaultVersion ¶
type CfnResourceDefaultVersion interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawscloudformation.IResourceDefaultVersionRef
// The Amazon Resource Name (ARN) of the resource.
AttrArn() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// 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
Env() *interfaces.ResourceEnvironment
// 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 reference to a ResourceDefaultVersion resource.
ResourceDefaultVersionRef() *interfacesawscloudformation.ResourceDefaultVersionReference
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The name of the resource.
TypeName() *string
SetTypeName(val *string)
// The Amazon Resource Name (ARN) of the resource version.
TypeVersionArn() *string
SetTypeVersionArn(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{}
// The ID of a specific version of the resource.
VersionId() *string
SetVersionId(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{})
}
The `AWS::CloudFormation::ResourceDefaultVersion` resource specifies the default version of a resource.
The default version of a resource will be used in CloudFormation operations.
For information about the CloudFormation registry, see [Managing extensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the *AWS CloudFormation User 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"
cfnResourceDefaultVersion := awscdk.Aws_cloudformation.NewCfnResourceDefaultVersion(this, jsii.String("MyCfnResourceDefaultVersion"), &CfnResourceDefaultVersionProps{
TypeName: jsii.String("typeName"),
TypeVersionArn: jsii.String("typeVersionArn"),
VersionId: jsii.String("versionId"),
})
func NewCfnResourceDefaultVersion ¶
func NewCfnResourceDefaultVersion(scope constructs.Construct, id *string, props *CfnResourceDefaultVersionProps) CfnResourceDefaultVersion
Create a new `AWS::CloudFormation::ResourceDefaultVersion`.
type CfnResourceDefaultVersionProps ¶
type CfnResourceDefaultVersionProps struct {
// The name of the resource.
//
// Conditional: You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html#cfn-cloudformation-resourcedefaultversion-typename
//
TypeName *string `field:"optional" json:"typeName" yaml:"typeName"`
// The Amazon Resource Name (ARN) of the resource version.
//
// Conditional: You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html#cfn-cloudformation-resourcedefaultversion-typeversionarn
//
TypeVersionArn *string `field:"optional" json:"typeVersionArn" yaml:"typeVersionArn"`
// The ID of a specific version of the resource.
//
// The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the resource version when it's registered.
//
// Conditional: You must specify either `TypeVersionArn` , or `TypeName` and `VersionId` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourcedefaultversion.html#cfn-cloudformation-resourcedefaultversion-versionid
//
VersionId *string `field:"optional" json:"versionId" yaml:"versionId"`
}
Properties for defining a `CfnResourceDefaultVersion`.
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"
cfnResourceDefaultVersionProps := &CfnResourceDefaultVersionProps{
TypeName: jsii.String("typeName"),
TypeVersionArn: jsii.String("typeVersionArn"),
VersionId: jsii.String("versionId"),
}
type CfnResourceVersion ¶
type CfnResourceVersion interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawscloudformation.IResourceVersionRef
// The Amazon Resource Name (ARN) of the resource.
AttrArn() *string
// Whether the specified resource version is set as the default version.
//
// This applies only to private extensions you have registered in your account, and extensions published by AWS . For public third-party extensions, whether they are activated in your account, CloudFormation returns `null` .
AttrIsDefaultVersion() awscdk.IResolvable
// For resource type extensions, the provisioning behavior of the resource type.
//
// CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.
//
// Possible values:
//
// - `FULLY_MUTABLE` : The resource type includes an update handler to process updates to the type during stack update operations.
// - `IMMUTABLE` : The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.
// - `NON_PROVISIONABLE` : The resource type doesn't include all the following handlers, and therefore can't actually be provisioned.
//
// - create
// - read
// - delete.
AttrProvisioningType() *string
// The Amazon Resource Name (ARN) for the extension.
AttrTypeArn() *string
// The ID of a specific version of the resource.
//
// The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the resource version when it is registered.
AttrVersionId() *string
// The visibility level that determines who can see and use this resource in CloudFormation operations:.
//
// - `PRIVATE` : The resource is only visible and usable within the account where it was registered. CloudFormation automatically marks any resources you register as `PRIVATE` .
// - `PUBLIC` : The resource is publicly visible and usable within any AWS account.
AttrVisibility() *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
Env() *interfaces.ResourceEnvironment
// The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource.
ExecutionRoleArn() *string
SetExecutionRoleArn(val *string)
// Logging configuration information for a resource.
LoggingConfig() interface{}
SetLoggingConfig(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 reference to a ResourceVersion resource.
ResourceVersionRef() *interfacesawscloudformation.ResourceVersionReference
// A URL to the S3 bucket for the resource project package that contains the necessary files for the resource you want to register.
SchemaHandlerPackage() *string
SetSchemaHandlerPackage(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 name of the resource being registered.
TypeName() *string
SetTypeName(val *string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The `AWS::CloudFormation::ResourceVersion` resource registers a resource version with the CloudFormation registry.
Registering a resource version makes it available for use in CloudFormation templates in your AWS account , and includes:
- Validating the resource schema. - Determining which handlers, if any, have been specified for the resource. - Making the resource available for use in your account.
For information about the CloudFormation registry, see [Managing extensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the *AWS CloudFormation User Guide* .
You can have a maximum of 50 resource versions registered at a time. This maximum is per account and per Region.
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"
cfnResourceVersion := awscdk.Aws_cloudformation.NewCfnResourceVersion(this, jsii.String("MyCfnResourceVersion"), &CfnResourceVersionProps{
SchemaHandlerPackage: jsii.String("schemaHandlerPackage"),
TypeName: jsii.String("typeName"),
// the properties below are optional
ExecutionRoleArn: jsii.String("executionRoleArn"),
LoggingConfig: &LoggingConfigProperty{
LogGroupName: jsii.String("logGroupName"),
LogRoleArn: jsii.String("logRoleArn"),
},
})
func NewCfnResourceVersion ¶
func NewCfnResourceVersion(scope constructs.Construct, id *string, props *CfnResourceVersionProps) CfnResourceVersion
Create a new `AWS::CloudFormation::ResourceVersion`.
type CfnResourceVersionProps ¶
type CfnResourceVersionProps struct {
// A URL to the S3 bucket for the resource project package that contains the necessary files for the resource you want to register.
//
// For information on generating a schema handler package, see [Modeling resource types to use with AWS CloudFormation](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-model.html) in the *AWS CloudFormation Command Line Interface (CLI) User Guide* .
//
// > To register the resource version, you must have `s3:GetObject` permissions to access the S3 objects.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-schemahandlerpackage
//
SchemaHandlerPackage *string `field:"required" json:"schemaHandlerPackage" yaml:"schemaHandlerPackage"`
// The name of the resource being registered.
//
// We recommend that resource names adhere to the following pattern: *company_or_organization* :: *service* :: *type* .
//
// > The following organization namespaces are reserved and can't be used in your resource names:
// >
// > - `Alexa`
// > - `AMZN`
// > - `Amazon`
// > - `AWS`
// > - `Custom`
// > - `Dev`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-typename
//
TypeName *string `field:"required" json:"typeName" yaml:"typeName"`
// The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource.
//
// If your resource calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-executionrolearn
//
ExecutionRoleArn *string `field:"optional" json:"executionRoleArn" yaml:"executionRoleArn"`
// Logging configuration information for a resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-loggingconfig
//
LoggingConfig interface{} `field:"optional" json:"loggingConfig" yaml:"loggingConfig"`
}
Properties for defining a `CfnResourceVersion`.
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"
cfnResourceVersionProps := &CfnResourceVersionProps{
SchemaHandlerPackage: jsii.String("schemaHandlerPackage"),
TypeName: jsii.String("typeName"),
// the properties below are optional
ExecutionRoleArn: jsii.String("executionRoleArn"),
LoggingConfig: &LoggingConfigProperty{
LogGroupName: jsii.String("logGroupName"),
LogRoleArn: jsii.String("logRoleArn"),
},
}
type CfnResourceVersion_LoggingConfigProperty ¶
type CfnResourceVersion_LoggingConfigProperty struct {
// The Amazon CloudWatch logs group to which CloudFormation sends error logging information when invoking the type's handlers.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-resourceversion-loggingconfig.html#cfn-cloudformation-resourceversion-loggingconfig-loggroupname
//
LogGroupName *string `field:"optional" json:"logGroupName" yaml:"logGroupName"`
// The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-resourceversion-loggingconfig.html#cfn-cloudformation-resourceversion-loggingconfig-logrolearn
//
LogRoleArn *string `field:"optional" json:"logRoleArn" yaml:"logRoleArn"`
}
Logging configuration information for a resource.
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"
loggingConfigProperty := &LoggingConfigProperty{
LogGroupName: jsii.String("logGroupName"),
LogRoleArn: jsii.String("logRoleArn"),
}
type CfnStack ¶
type CfnStack interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawscloudformation.IStackRef
awscdk.ITaggable
// Returns the unique identifier of the change set.
AttrChangeSetId() *string
// Returns the time the stack was created.
AttrCreationTime() *string
// Returns the time the stack was last updated.
//
// This will only be returned if the stack has been updated at least once.
AttrLastUpdateTime() *string
// Returns a list of output structures.
AttrOutputs() awscdk.IResolvable
// For nested stacks, returns the stack ID of the direct parent of this stack.
//
// For the first level of nested stacks, the root stack is also the parent stack.
AttrParentId() *string
// For nested stacks, returns the stack ID of the top-level stack to which the nested stack ultimately belongs.
AttrRootId() *string
// Returns the unique identifier of the stack.
AttrStackId() *string
// Returns a success or failure message associated with the stack status.
AttrStackStatus() *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
Env() *interfaces.ResourceEnvironment
// 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 Amazon SNS topic ARNs to publish stack related events.
NotificationArns() *[]*string
SetNotificationArns(val *[]*string)
// The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created.
Parameters() interface{}
SetParameters(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
// A reference to a Stack resource.
StackRef() *interfacesawscloudformation.StackReference
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// Key-value pairs to associate with this stack.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// The URL of a file that contains the template body.
TemplateUrl() *string
SetTemplateUrl(val *string)
// The length of time, in minutes, that CloudFormation waits for the nested stack to reach the `CREATE_COMPLETE` state.
TimeoutInMinutes() *float64
SetTimeoutInMinutes(val *float64)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The `AWS::CloudFormation::Stack` resource nests a stack as a resource in a top-level template.
For more information, see [Nested stacks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) in the *AWS CloudFormation User Guide* .
You can add output values from a nested stack within the containing template. You use the [GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html) function with the nested stack's logical name and the name of the output value in the nested stack in the format `Outputs. *NestedStackOutputName*` .
We strongly recommend that updates to nested stacks are run from the parent stack.
When you apply template changes to update a top-level stack, CloudFormation updates the top-level stack and initiates an update to its nested stacks. CloudFormation updates the resources of modified nested stacks, but doesn't update the resources of unmodified nested stacks.
For stacks that contain IAM resources, you must acknowledge IAM capabilities. Also, make sure that you have cancel update stack permissions, which are required if an update rolls back. For more information about IAM and CloudFormation , see [Controlling access with AWS Identity and Access Management](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html) in the *AWS CloudFormation User Guide* .
> A subset of `AWS::CloudFormation::Stack` resource type properties listed below are available to customers using CloudFormation , AWS CDK , and Cloud Control to configure. > > - `NotificationARNs` > - `Parameters` > - `Tags` > - `TemplateURL` > - `TimeoutInMinutes` > > These properties can be configured only when using Cloud Control . This is because the below properties are set by the parent stack, and thus cannot be configured using CloudFormation or AWS CDK but only Cloud Control . > > - `Capabilities` > - `Description` > - `DisableRollback` > - `EnableTerminationProtection` > - `RoleARN` > - `StackName` > - `StackPolicyBody` > - `StackPolicyURL` > - `StackStatusReason` > - `TemplateBody` > > Customers that configure `AWS::CloudFormation::Stack` using CloudFormation and AWS CDK can do so for nesting a CloudFormation stack as a resource in their top-level template. > > These read-only properties can be accessed only when using Cloud Control . > > - `ChangeSetId` > - `CreationTime` > - `LastUpdateTime` > - `Outputs` > - `ParentId` > - `RootId` > - `StackId` > - `StackStatus`.
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"
cfnStack := awscdk.Aws_cloudformation.NewCfnStack(this, jsii.String("MyCfnStack"), &CfnStackProps{
NotificationArns: []*string{
jsii.String("notificationArns"),
},
Parameters: map[string]*string{
"parametersKey": jsii.String("parameters"),
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TemplateUrl: jsii.String("templateUrl"),
TimeoutInMinutes: jsii.Number(123),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html
func NewCfnStack ¶
func NewCfnStack(scope constructs.Construct, id *string, props *CfnStackProps) CfnStack
Create a new `AWS::CloudFormation::Stack`.
type CfnStackProps ¶
type CfnStackProps struct {
// The Amazon SNS topic ARNs to publish stack related events.
//
// You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html#cfn-cloudformation-stack-notificationarns
//
NotificationArns *[]*string `field:"optional" json:"notificationArns" yaml:"notificationArns"`
// The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created.
//
// Each parameter has a name corresponding to a parameter defined in the embedded template and a value representing the value that you want to set for the parameter.
//
// > If you use the `Ref` function to pass a parameter value to a nested stack, comma-delimited list parameters must be of type `String` . In other words, you can't pass values that are of type `CommaDelimitedList` to nested stacks.
//
// Required if the nested stack requires input parameters.
//
// Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html#cfn-cloudformation-stack-parameters
//
Parameters interface{} `field:"optional" json:"parameters" yaml:"parameters"`
// Key-value pairs to associate with this stack.
//
// CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html#cfn-cloudformation-stack-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// The URL of a file that contains the template body.
//
// The URL must point to a template (max size: 1 MB) that's located in an Amazon S3 bucket. The location for an Amazon S3 bucket must start with `https://` .
//
// Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html#cfn-cloudformation-stack-templateurl
//
TemplateUrl *string `field:"optional" json:"templateUrl" yaml:"templateUrl"`
// The length of time, in minutes, that CloudFormation waits for the nested stack to reach the `CREATE_COMPLETE` state.
//
// The default is no timeout. When CloudFormation detects that the nested stack has reached the `CREATE_COMPLETE` state, it marks the nested stack resource as `CREATE_COMPLETE` in the parent stack and resumes creating the parent stack. If the timeout period expires before the nested stack reaches `CREATE_COMPLETE` , CloudFormation marks the nested stack as failed and rolls back both the nested stack and parent stack.
//
// Updates aren't supported.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html#cfn-cloudformation-stack-timeoutinminutes
//
TimeoutInMinutes *float64 `field:"optional" json:"timeoutInMinutes" yaml:"timeoutInMinutes"`
}
Properties for defining a `CfnStack`.
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"
cfnStackProps := &CfnStackProps{
NotificationArns: []*string{
jsii.String("notificationArns"),
},
Parameters: map[string]*string{
"parametersKey": jsii.String("parameters"),
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TemplateUrl: jsii.String("templateUrl"),
TimeoutInMinutes: jsii.Number(123),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html
type CfnStackSet ¶
type CfnStackSet interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawscloudformation.IStackSetRef
awscdk.ITaggable
// The Amazon Resource Number (ARN) of the IAM role to use to create this StackSet.
AdministrationRoleArn() *string
SetAdministrationRoleArn(val *string)
// Returns the unique identifier of the resource.
AttrStackSetId() *string
// Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).
AutoDeployment() interface{}
SetAutoDeployment(val interface{})
// Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
CallAs() *string
SetCallAs(val *string)
// The capabilities that are allowed in the StackSet.
Capabilities() *[]*string
SetCapabilities(val *[]*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
// A description of the StackSet.
Description() *string
SetDescription(val *string)
Env() *interfaces.ResourceEnvironment
// The name of the IAM execution role to use to create the StackSet.
ExecutionRoleName() *string
SetExecutionRoleName(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
// Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
ManagedExecution() interface{}
SetManagedExecution(val interface{})
// The tree node.
Node() constructs.Node
// The user-specified preferences for how CloudFormation performs a StackSet operation.
OperationPreferences() interface{}
SetOperationPreferences(val interface{})
// The input parameters for the StackSet template.
Parameters() interface{}
SetParameters(val interface{})
// Describes how the IAM roles required for StackSet operations are created.
PermissionModel() *string
SetPermissionModel(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
// A group of stack instances with parameters in some specific accounts and Regions.
StackInstancesGroup() interface{}
SetStackInstancesGroup(val interface{})
// The name to associate with the StackSet.
StackSetName() *string
SetStackSetName(val *string)
// A reference to a StackSet resource.
StackSetRef() *interfacesawscloudformation.StackSetReference
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// Key-value pairs to associate with this stack.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.
TemplateBody() *string
SetTemplateBody(val *string)
// The URL of a file that contains the template body.
TemplateUrl() *string
SetTemplateUrl(val *string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The `AWS::CloudFormation::StackSet` resource contains information about a StackSet.
With StackSets, you can provision stacks across AWS accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.
> Run deployments to nested StackSets from the parent stack, not directly through the StackSet API.
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 managedExecution interface{}
cfnStackSet := awscdk.Aws_cloudformation.NewCfnStackSet(this, jsii.String("MyCfnStackSet"), &CfnStackSetProps{
PermissionModel: jsii.String("permissionModel"),
StackSetName: jsii.String("stackSetName"),
// the properties below are optional
AdministrationRoleArn: jsii.String("administrationRoleArn"),
AutoDeployment: &AutoDeploymentProperty{
Enabled: jsii.Boolean(false),
RetainStacksOnAccountRemoval: jsii.Boolean(false),
},
CallAs: jsii.String("callAs"),
Capabilities: []*string{
jsii.String("capabilities"),
},
Description: jsii.String("description"),
ExecutionRoleName: jsii.String("executionRoleName"),
ManagedExecution: managedExecution,
OperationPreferences: &OperationPreferencesProperty{
ConcurrencyMode: jsii.String("concurrencyMode"),
FailureToleranceCount: jsii.Number(123),
FailureTolerancePercentage: jsii.Number(123),
MaxConcurrentCount: jsii.Number(123),
MaxConcurrentPercentage: jsii.Number(123),
RegionConcurrencyType: jsii.String("regionConcurrencyType"),
RegionOrder: []*string{
jsii.String("regionOrder"),
},
},
Parameters: []interface{}{
&ParameterProperty{
ParameterKey: jsii.String("parameterKey"),
ParameterValue: jsii.String("parameterValue"),
},
},
StackInstancesGroup: []interface{}{
&StackInstancesProperty{
DeploymentTargets: &DeploymentTargetsProperty{
AccountFilterType: jsii.String("accountFilterType"),
Accounts: []*string{
jsii.String("accounts"),
},
AccountsUrl: jsii.String("accountsUrl"),
OrganizationalUnitIds: []*string{
jsii.String("organizationalUnitIds"),
},
},
Regions: []*string{
jsii.String("regions"),
},
// the properties below are optional
ParameterOverrides: []interface{}{
&ParameterProperty{
ParameterKey: jsii.String("parameterKey"),
ParameterValue: jsii.String("parameterValue"),
},
},
},
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TemplateBody: jsii.String("templateBody"),
TemplateUrl: jsii.String("templateUrl"),
})
func NewCfnStackSet ¶
func NewCfnStackSet(scope constructs.Construct, id *string, props *CfnStackSetProps) CfnStackSet
Create a new `AWS::CloudFormation::StackSet`.
type CfnStackSetProps ¶
type CfnStackSetProps struct {
// Describes how the IAM roles required for StackSet operations are created.
//
// - With `SELF_MANAGED` permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see [Grant self-managed permissions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html) in the *AWS CloudFormation User Guide* .
// - With `SERVICE_MANAGED` permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by AWS Organizations . For more information, see [Activate trusted access for StackSets with AWS Organizations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-activate-trusted-access.html) in the *AWS CloudFormation User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-permissionmodel
//
PermissionModel *string `field:"required" json:"permissionModel" yaml:"permissionModel"`
// The name to associate with the StackSet.
//
// The name must be unique in the Region where you create your StackSet.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-stacksetname
//
StackSetName *string `field:"required" json:"stackSetName" yaml:"stackSetName"`
// The Amazon Resource Number (ARN) of the IAM role to use to create this StackSet.
//
// Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account.
//
// Use customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account. For more information, see [Grant self-managed permissions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html) in the *AWS CloudFormation User Guide* .
//
// Valid only if the permissions model is `SELF_MANAGED` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-administrationrolearn
//
AdministrationRoleArn *string `field:"optional" json:"administrationRoleArn" yaml:"administrationRoleArn"`
// Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).
//
// For more information, see [Enable or disable automatic deployments for StackSets in AWS Organizations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-manage-auto-deployment.html) in the *AWS CloudFormation User Guide* .
//
// Required if the permissions model is `SERVICE_MANAGED` . (Not used with self-managed permissions.)
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-autodeployment
//
AutoDeployment interface{} `field:"optional" json:"autoDeployment" yaml:"autoDeployment"`
// Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
//
// By default, `SELF` is specified. Use `SELF` for StackSets with self-managed permissions.
//
// - To create a StackSet with service-managed permissions while signed in to the management account, specify `SELF` .
// - To create a StackSet with service-managed permissions while signed in to a delegated administrator account, specify `DELEGATED_ADMIN` .
//
// Your AWS account must be registered as a delegated admin in the management account. For more information, see [Register a delegated administrator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) in the *AWS CloudFormation User Guide* .
//
// StackSets with service-managed permissions are created in the management account, including StackSets that are created by delegated administrators.
//
// Valid only if the permissions model is `SERVICE_MANAGED` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-callas
//
CallAs *string `field:"optional" json:"callAs" yaml:"callAs"`
// The capabilities that are allowed in the StackSet.
//
// Some StackSet templates might include resources that can affect permissions in your AWS account —for example, by creating new IAM users. For more information, see [Acknowledging IAM resources in CloudFormation templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities) in the *AWS CloudFormation User Guide* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-capabilities
//
Capabilities *[]*string `field:"optional" json:"capabilities" yaml:"capabilities"`
// A description of the StackSet.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The name of the IAM execution role to use to create the StackSet.
//
// If you don't specify an execution role, CloudFormation uses the `AWSCloudFormationStackSetExecutionRole` role for the StackSet operation.
//
// Valid only if the permissions model is `SELF_MANAGED` .
//
// *Pattern* : `[a-zA-Z_0-9+=,.@-]+`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-executionrolename
//
ExecutionRoleName *string `field:"optional" json:"executionRoleName" yaml:"executionRoleName"`
// Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
//
// When active, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.
//
// > If there are already running or queued operations, StackSets queues all incoming operations even if they are non-conflicting.
// >
// > You can't modify your StackSet's execution configuration while there are running or queued operations for that StackSet.
//
// When inactive (default), StackSets performs one operation at a time in request order.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-managedexecution
//
ManagedExecution interface{} `field:"optional" json:"managedExecution" yaml:"managedExecution"`
// The user-specified preferences for how CloudFormation performs a StackSet operation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-operationpreferences
//
OperationPreferences interface{} `field:"optional" json:"operationPreferences" yaml:"operationPreferences"`
// The input parameters for the StackSet template.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-parameters
//
Parameters interface{} `field:"optional" json:"parameters" yaml:"parameters"`
// A group of stack instances with parameters in some specific accounts and Regions.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-stackinstancesgroup
//
StackInstancesGroup interface{} `field:"optional" json:"stackInstancesGroup" yaml:"stackInstancesGroup"`
// Key-value pairs to associate with this stack.
//
// CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags.
//
// If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.
//
// You must include either `TemplateURL` or `TemplateBody` in a StackSet, but you can't use both. Dynamic references in the `TemplateBody` may not work correctly in all cases. It's recommended to pass templates that contain dynamic references through `TemplateUrl` instead.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-templatebody
//
TemplateBody *string `field:"optional" json:"templateBody" yaml:"templateBody"`
// The URL of a file that contains the template body.
//
// The URL must point to a template (max size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with `https://` .
//
// Conditional: You must specify only one of the following parameters: `TemplateBody` , `TemplateURL` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-templateurl
//
TemplateUrl *string `field:"optional" json:"templateUrl" yaml:"templateUrl"`
}
Properties for defining a `CfnStackSet`.
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 managedExecution interface{}
cfnStackSetProps := &CfnStackSetProps{
PermissionModel: jsii.String("permissionModel"),
StackSetName: jsii.String("stackSetName"),
// the properties below are optional
AdministrationRoleArn: jsii.String("administrationRoleArn"),
AutoDeployment: &AutoDeploymentProperty{
Enabled: jsii.Boolean(false),
RetainStacksOnAccountRemoval: jsii.Boolean(false),
},
CallAs: jsii.String("callAs"),
Capabilities: []*string{
jsii.String("capabilities"),
},
Description: jsii.String("description"),
ExecutionRoleName: jsii.String("executionRoleName"),
ManagedExecution: managedExecution,
OperationPreferences: &OperationPreferencesProperty{
ConcurrencyMode: jsii.String("concurrencyMode"),
FailureToleranceCount: jsii.Number(123),
FailureTolerancePercentage: jsii.Number(123),
MaxConcurrentCount: jsii.Number(123),
MaxConcurrentPercentage: jsii.Number(123),
RegionConcurrencyType: jsii.String("regionConcurrencyType"),
RegionOrder: []*string{
jsii.String("regionOrder"),
},
},
Parameters: []interface{}{
&ParameterProperty{
ParameterKey: jsii.String("parameterKey"),
ParameterValue: jsii.String("parameterValue"),
},
},
StackInstancesGroup: []interface{}{
&StackInstancesProperty{
DeploymentTargets: &DeploymentTargetsProperty{
AccountFilterType: jsii.String("accountFilterType"),
Accounts: []*string{
jsii.String("accounts"),
},
AccountsUrl: jsii.String("accountsUrl"),
OrganizationalUnitIds: []*string{
jsii.String("organizationalUnitIds"),
},
},
Regions: []*string{
jsii.String("regions"),
},
// the properties below are optional
ParameterOverrides: []interface{}{
&ParameterProperty{
ParameterKey: jsii.String("parameterKey"),
ParameterValue: jsii.String("parameterValue"),
},
},
},
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TemplateBody: jsii.String("templateBody"),
TemplateUrl: jsii.String("templateUrl"),
}
type CfnStackSet_AutoDeploymentProperty ¶
type CfnStackSet_AutoDeploymentProperty struct {
// If set to `true` , StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions.
//
// If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-autodeployment.html#cfn-cloudformation-stackset-autodeployment-enabled
//
Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"`
// If set to `true` , stack resources are retained when an account is removed from a target organization or OU.
//
// If set to `false` , stack resources are deleted. Specify only if `Enabled` is set to `True` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-autodeployment.html#cfn-cloudformation-stackset-autodeployment-retainstacksonaccountremoval
//
RetainStacksOnAccountRemoval interface{} `field:"optional" json:"retainStacksOnAccountRemoval" yaml:"retainStacksOnAccountRemoval"`
}
Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).
For more information, see [Enable or disable automatic deployments for StackSets in AWS Organizations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-manage-auto-deployment.html) in the *AWS CloudFormation User 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"
autoDeploymentProperty := &AutoDeploymentProperty{
Enabled: jsii.Boolean(false),
RetainStacksOnAccountRemoval: jsii.Boolean(false),
}
type CfnStackSet_DeploymentTargetsProperty ¶
type CfnStackSet_DeploymentTargetsProperty struct {
// Refines which accounts to deploy stacks to by specifying how to use the `Accounts` and `OrganizationalUnitIds` properties together.
//
// The following values determine how CloudFormation selects target accounts:
//
// - `INTERSECTION` : StackSet deploys to the accounts specified in the `Accounts` property.
// - `DIFFERENCE` : StackSet deploys to the OU, excluding the accounts specified in the `Accounts` property.
// - `UNION` : StackSet deploys to the OU, and the accounts specified in the `Accounts` property. `UNION` is not supported for create operations when using StackSet as a resource or the `CreateStackInstances` API.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html#cfn-cloudformation-stackset-deploymenttargets-accountfiltertype
//
AccountFilterType *string `field:"optional" json:"accountFilterType" yaml:"accountFilterType"`
// The account IDs of the AWS accounts .
//
// If you have many account numbers, you can provide those accounts using the `AccountsUrl` property instead.
//
// *Pattern* : `^[0-9]{12}$`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html#cfn-cloudformation-stackset-deploymenttargets-accounts
//
Accounts *[]*string `field:"optional" json:"accounts" yaml:"accounts"`
// The Amazon S3 URL path to a file that contains a list of AWS account IDs.
//
// The file format must be either `.csv` or `.txt` , and the data can be comma-separated or new-line-separated. There is currently a 10MB limit for the data (approximately 800,000 accounts).
//
// This property serves the same purpose as `Accounts` but allows you to specify a large number of accounts.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html#cfn-cloudformation-stackset-deploymenttargets-accountsurl
//
AccountsUrl *string `field:"optional" json:"accountsUrl" yaml:"accountsUrl"`
// The organization root ID or organizational unit (OU) IDs.
//
// *Pattern* : `^(ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}|r-[a-z0-9]{4,32})$`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-deploymenttargets.html#cfn-cloudformation-stackset-deploymenttargets-organizationalunitids
//
OrganizationalUnitIds *[]*string `field:"optional" json:"organizationalUnitIds" yaml:"organizationalUnitIds"`
}
The AWS Organizations accounts or AWS accounts to deploy stacks to in the specified Regions.
When deploying to AWS Organizations accounts with `SERVICE_MANAGED` permissions:
- You must specify the `OrganizationalUnitIds` property. - If you specify organizational units (OUs) for `OrganizationalUnitIds` and use either the `Accounts` or `AccountsUrl` property, you must also specify the `AccountFilterType` property.
When deploying to AWS accounts with `SELF_MANAGED` permissions:
- You must specify either the `Accounts` or `AccountsUrl` property, but not both.
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"
deploymentTargetsProperty := &DeploymentTargetsProperty{
AccountFilterType: jsii.String("accountFilterType"),
Accounts: []*string{
jsii.String("accounts"),
},
AccountsUrl: jsii.String("accountsUrl"),
OrganizationalUnitIds: []*string{
jsii.String("organizationalUnitIds"),
},
}
type CfnStackSet_ManagedExecutionProperty ¶ added in v2.55.0
type CfnStackSet_ManagedExecutionProperty struct {
// When `true` , CloudFormation performs non-conflicting operations concurrently and queues conflicting operations.
//
// After conflicting operations finish, CloudFormation starts queued operations in request order.
//
// > If there are already running or queued operations, CloudFormation queues all incoming operations even if they are non-conflicting.
// >
// > You can't modify your StackSet's execution configuration while there are running or queued operations for that StackSet.
//
// When `false` (default), StackSets performs one operation at a time in request order.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-managedexecution.html#cfn-cloudformation-stackset-managedexecution-active
//
Active interface{} `field:"optional" json:"active" yaml:"active"`
}
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
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"
managedExecutionProperty := &ManagedExecutionProperty{
Active: jsii.Boolean(false),
}
type CfnStackSet_OperationPreferencesProperty ¶
type CfnStackSet_OperationPreferencesProperty struct {
// Specifies how the concurrency level behaves during the operation execution.
//
// - `STRICT_FAILURE_TOLERANCE` : This option dynamically lowers the concurrency level to ensure the number of failed accounts never exceeds the value of `FailureToleranceCount` +1. The initial actual concurrency is set to the lower of either the value of the `MaxConcurrentCount` , or the value of `FailureToleranceCount` +1. The actual concurrency is then reduced proportionally by the number of failures. This is the default behavior.
//
// If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior is similar.
// - `SOFT_FAILURE_TOLERANCE` : This option decouples `FailureToleranceCount` from the actual concurrency. This allows StackSet operations to run at the concurrency level set by the `MaxConcurrentCount` value, or `MaxConcurrentPercentage` , regardless of the number of failures.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-concurrencymode
//
ConcurrencyMode *string `field:"optional" json:"concurrencyMode" yaml:"concurrencyMode"`
// The number of accounts per Region this operation can fail in before CloudFormation stops the operation in that Region.
//
// If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.
//
// Conditional: You must specify either `FailureToleranceCount` or `FailureTolerancePercentage` (but not both).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-failuretolerancecount
//
FailureToleranceCount *float64 `field:"optional" json:"failureToleranceCount" yaml:"failureToleranceCount"`
// The percentage of accounts per Region this stack operation can fail in before CloudFormation stops the operation in that Region.
//
// If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.
//
// When calculating the number of accounts based on the specified percentage, CloudFormation rounds *down* to the next whole number.
//
// Conditional: You must specify either `FailureToleranceCount` or `FailureTolerancePercentage` , but not both.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-failuretolerancepercentage
//
FailureTolerancePercentage *float64 `field:"optional" json:"failureTolerancePercentage" yaml:"failureTolerancePercentage"`
// The maximum number of accounts in which to perform this operation at one time.
//
// This is dependent on the value of `FailureToleranceCount` . `MaxConcurrentCount` is at most one more than the `FailureToleranceCount` .
//
// Note that this setting lets you specify the *maximum* for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
//
// Conditional: You must specify either `MaxConcurrentCount` or `MaxConcurrentPercentage` , but not both.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-maxconcurrentcount
//
MaxConcurrentCount *float64 `field:"optional" json:"maxConcurrentCount" yaml:"maxConcurrentCount"`
// The maximum percentage of accounts in which to perform this operation at one time.
//
// When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.
//
// Note that this setting lets you specify the *maximum* for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
//
// Conditional: You must specify either `MaxConcurrentCount` or `MaxConcurrentPercentage` , but not both.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-maxconcurrentpercentage
//
MaxConcurrentPercentage *float64 `field:"optional" json:"maxConcurrentPercentage" yaml:"maxConcurrentPercentage"`
// The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-regionconcurrencytype
//
RegionConcurrencyType *string `field:"optional" json:"regionConcurrencyType" yaml:"regionConcurrencyType"`
// The order of the Regions where you want to perform the stack operation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-regionorder
//
RegionOrder *[]*string `field:"optional" json:"regionOrder" yaml:"regionOrder"`
}
The user-specified preferences for how CloudFormation performs a StackSet operation.
For more information on maximum concurrent accounts and failure tolerance, see [StackSet operation options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options) in the *AWS CloudFormation User 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"
operationPreferencesProperty := &OperationPreferencesProperty{
ConcurrencyMode: jsii.String("concurrencyMode"),
FailureToleranceCount: jsii.Number(123),
FailureTolerancePercentage: jsii.Number(123),
MaxConcurrentCount: jsii.Number(123),
MaxConcurrentPercentage: jsii.Number(123),
RegionConcurrencyType: jsii.String("regionConcurrencyType"),
RegionOrder: []*string{
jsii.String("regionOrder"),
},
}
type CfnStackSet_ParameterProperty ¶
type CfnStackSet_ParameterProperty struct {
// The key associated with the parameter.
//
// If you don't specify a key and value for a particular parameter, CloudFormation uses the default value that's specified in your template.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-parameter.html#cfn-cloudformation-stackset-parameter-parameterkey
//
ParameterKey *string `field:"required" json:"parameterKey" yaml:"parameterKey"`
// The input value associated with the parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-parameter.html#cfn-cloudformation-stackset-parameter-parametervalue
//
ParameterValue *string `field:"required" json:"parameterValue" yaml:"parameterValue"`
}
The Parameter data 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"
parameterProperty := &ParameterProperty{
ParameterKey: jsii.String("parameterKey"),
ParameterValue: jsii.String("parameterValue"),
}
type CfnStackSet_StackInstancesProperty ¶
type CfnStackSet_StackInstancesProperty struct {
// The AWS Organizations accounts or AWS accounts to deploy stacks to in the specified Regions.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-stackinstances.html#cfn-cloudformation-stackset-stackinstances-deploymenttargets
//
DeploymentTargets interface{} `field:"required" json:"deploymentTargets" yaml:"deploymentTargets"`
// The names of one or more Regions where you want to create stack instances using the specified AWS accounts .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-stackinstances.html#cfn-cloudformation-stackset-stackinstances-regions
//
Regions *[]*string `field:"required" json:"regions" yaml:"regions"`
// A list of StackSet parameters whose values you want to override in the selected stack instances.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-stackinstances.html#cfn-cloudformation-stackset-stackinstances-parameteroverrides
//
ParameterOverrides interface{} `field:"optional" json:"parameterOverrides" yaml:"parameterOverrides"`
}
Stack instances in some specific accounts and Regions.
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"
stackInstancesProperty := &StackInstancesProperty{
DeploymentTargets: &DeploymentTargetsProperty{
AccountFilterType: jsii.String("accountFilterType"),
Accounts: []*string{
jsii.String("accounts"),
},
AccountsUrl: jsii.String("accountsUrl"),
OrganizationalUnitIds: []*string{
jsii.String("organizationalUnitIds"),
},
},
Regions: []*string{
jsii.String("regions"),
},
// the properties below are optional
ParameterOverrides: []interface{}{
&ParameterProperty{
ParameterKey: jsii.String("parameterKey"),
ParameterValue: jsii.String("parameterValue"),
},
},
}
type CfnStack_OutputProperty ¶ added in v2.97.0
type CfnStack_OutputProperty struct {
// User defined description associated with the output.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stack-output.html#cfn-cloudformation-stack-output-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The name of the export associated with the output.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stack-output.html#cfn-cloudformation-stack-output-exportname
//
ExportName *string `field:"optional" json:"exportName" yaml:"exportName"`
// The key associated with the output.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stack-output.html#cfn-cloudformation-stack-output-outputkey
//
OutputKey *string `field:"optional" json:"outputKey" yaml:"outputKey"`
// The value associated with the output.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stack-output.html#cfn-cloudformation-stack-output-outputvalue
//
OutputValue *string `field:"optional" json:"outputValue" yaml:"outputValue"`
}
The Output data 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"
outputProperty := &OutputProperty{
Description: jsii.String("description"),
ExportName: jsii.String("exportName"),
OutputKey: jsii.String("outputKey"),
OutputValue: jsii.String("outputValue"),
}
type CfnTypeActivation ¶
type CfnTypeActivation interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawscloudformation.ITypeActivationRef
// The Amazon Resource Name (ARN) of the activated extension in this account and Region.
AttrArn() *string
// Whether to automatically update the extension in this account and Region when a new *minor* version is published by the extension publisher.
AutoUpdate() interface{}
SetAutoUpdate(val interface{})
// 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
Env() *interfaces.ResourceEnvironment
// The name of the IAM execution role to use to activate the extension.
ExecutionRoleArn() *string
SetExecutionRoleArn(val *string)
// Specifies logging configuration information for an extension.
LoggingConfig() interface{}
SetLoggingConfig(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 major version of this extension you want to activate, if multiple major versions are available.
MajorVersion() *string
SetMajorVersion(val *string)
// The tree node.
Node() constructs.Node
// The Amazon Resource Number (ARN) of the public extension.
PublicTypeArn() *string
SetPublicTypeArn(val *string)
// The ID of the extension publisher.
PublisherId() *string
SetPublisherId(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 extension type.
Type() *string
SetType(val *string)
// A reference to a TypeActivation resource.
TypeActivationRef() *interfacesawscloudformation.TypeActivationReference
// The name of the extension.
TypeName() *string
SetTypeName(val *string)
// An alias to assign to the public extension in this account and Region.
TypeNameAlias() *string
SetTypeNameAlias(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{}
// Manually updates a previously-activated type to a new major or minor version, if available.
VersionBump() *string
SetVersionBump(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{})
}
The `AWS::CloudFormation::TypeActivation` resource activates a public third-party extension, making it available for use in stack templates.
For information about the CloudFormation registry, see [Managing extensions with the CloudFormation registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) in the *AWS CloudFormation User 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"
cfnTypeActivation := awscdk.Aws_cloudformation.NewCfnTypeActivation(this, jsii.String("MyCfnTypeActivation"), &CfnTypeActivationProps{
AutoUpdate: jsii.Boolean(false),
ExecutionRoleArn: jsii.String("executionRoleArn"),
LoggingConfig: &LoggingConfigProperty{
LogGroupName: jsii.String("logGroupName"),
LogRoleArn: jsii.String("logRoleArn"),
},
MajorVersion: jsii.String("majorVersion"),
PublicTypeArn: jsii.String("publicTypeArn"),
PublisherId: jsii.String("publisherId"),
Type: jsii.String("type"),
TypeName: jsii.String("typeName"),
TypeNameAlias: jsii.String("typeNameAlias"),
VersionBump: jsii.String("versionBump"),
})
func NewCfnTypeActivation ¶
func NewCfnTypeActivation(scope constructs.Construct, id *string, props *CfnTypeActivationProps) CfnTypeActivation
Create a new `AWS::CloudFormation::TypeActivation`.
type CfnTypeActivationProps ¶
type CfnTypeActivationProps struct {
// Whether to automatically update the extension in this account and Region when a new *minor* version is published by the extension publisher.
//
// Major versions released by the publisher must be manually updated.
//
// The default is `true` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-autoupdate
//
AutoUpdate interface{} `field:"optional" json:"autoUpdate" yaml:"autoUpdate"`
// The name of the IAM execution role to use to activate the extension.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-executionrolearn
//
ExecutionRoleArn *string `field:"optional" json:"executionRoleArn" yaml:"executionRoleArn"`
// Specifies logging configuration information for an extension.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-loggingconfig
//
LoggingConfig interface{} `field:"optional" json:"loggingConfig" yaml:"loggingConfig"`
// The major version of this extension you want to activate, if multiple major versions are available.
//
// The default is the latest major version. CloudFormation uses the latest available *minor* version of the major version selected.
//
// You can specify `MajorVersion` or `VersionBump` , but not both.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-majorversion
//
MajorVersion *string `field:"optional" json:"majorVersion" yaml:"majorVersion"`
// The Amazon Resource Number (ARN) of the public extension.
//
// Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-publictypearn
//
PublicTypeArn *string `field:"optional" json:"publicTypeArn" yaml:"publicTypeArn"`
// The ID of the extension publisher.
//
// Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-publisherid
//
PublisherId *string `field:"optional" json:"publisherId" yaml:"publisherId"`
// The extension type.
//
// Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-type
//
Type *string `field:"optional" json:"type" yaml:"type"`
// The name of the extension.
//
// Conditional: You must specify `PublicTypeArn` , or `TypeName` , `Type` , and `PublisherId` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-typename
//
TypeName *string `field:"optional" json:"typeName" yaml:"typeName"`
// An alias to assign to the public extension in this account and Region.
//
// If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.
//
// An extension alias must be unique within a given account and Region. You can activate the same public resource multiple times in the same account and Region, using different type name aliases.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-typenamealias
//
TypeNameAlias *string `field:"optional" json:"typeNameAlias" yaml:"typeNameAlias"`
// Manually updates a previously-activated type to a new major or minor version, if available.
//
// You can also use this parameter to update the value of `AutoUpdate` .
//
// - `MAJOR` : CloudFormation updates the extension to the newest major version, if one is available.
// - `MINOR` : CloudFormation updates the extension to the newest minor version, if one is available.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-versionbump
//
VersionBump *string `field:"optional" json:"versionBump" yaml:"versionBump"`
}
Properties for defining a `CfnTypeActivation`.
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"
cfnTypeActivationProps := &CfnTypeActivationProps{
AutoUpdate: jsii.Boolean(false),
ExecutionRoleArn: jsii.String("executionRoleArn"),
LoggingConfig: &LoggingConfigProperty{
LogGroupName: jsii.String("logGroupName"),
LogRoleArn: jsii.String("logRoleArn"),
},
MajorVersion: jsii.String("majorVersion"),
PublicTypeArn: jsii.String("publicTypeArn"),
PublisherId: jsii.String("publisherId"),
Type: jsii.String("type"),
TypeName: jsii.String("typeName"),
TypeNameAlias: jsii.String("typeNameAlias"),
VersionBump: jsii.String("versionBump"),
}
type CfnTypeActivation_LoggingConfigProperty ¶
type CfnTypeActivation_LoggingConfigProperty struct {
// The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the extension's handlers.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-typeactivation-loggingconfig.html#cfn-cloudformation-typeactivation-loggingconfig-loggroupname
//
LogGroupName *string `field:"optional" json:"logGroupName" yaml:"logGroupName"`
// The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries to CloudWatch Logs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-typeactivation-loggingconfig.html#cfn-cloudformation-typeactivation-loggingconfig-logrolearn
//
LogRoleArn *string `field:"optional" json:"logRoleArn" yaml:"logRoleArn"`
}
Contains logging configuration information for an extension.
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"
loggingConfigProperty := &LoggingConfigProperty{
LogGroupName: jsii.String("logGroupName"),
LogRoleArn: jsii.String("logRoleArn"),
}
type CfnWaitCondition ¶
type CfnWaitCondition interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawscloudformation.IWaitConditionRef
AttrData() awscdk.IResolvable
// Returns a unique identifier for the resource.
AttrId() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// The number of success signals that CloudFormation must receive before it continues the stack creation process.
Count() *float64
SetCount(val *float64)
// 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
Env() *interfaces.ResourceEnvironment
// A reference to the wait condition handle used to signal this wait condition.
Handle() *string
SetHandle(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
// The length of time (in seconds) to wait for the number of signals that the `Count` property specifies.
Timeout() *string
SetTimeout(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{}
// A reference to a WaitCondition resource.
WaitConditionRef() *interfacesawscloudformation.WaitConditionReference
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The `AWS::CloudFormation::WaitCondition` resource provides a way to coordinate stack resource creation with configuration actions that are external to the stack creation or to track the status of a configuration process.
In these situations, we recommend that you associate a `CreationPolicy` attribute with the wait condition instead of using a wait condition handle. For more information and an example, see [CreationPolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-attribute-creationpolicy.html) in the *AWS CloudFormation User Guide* . If you use a `CreationPolicy` with a wait condition, don't specify any of the wait condition's properties.
> If you use AWS PrivateLink , resources in the VPC that respond to wait conditions must have access to CloudFormation , specific Amazon S3 buckets. Resources must send wait condition responses to a presigned Amazon S3 URL. If they can't send responses to Amazon S3 , CloudFormation won't receive a response and the stack operation fails. For more information, see [Access CloudFormation using an interface endpoint ( AWS PrivateLink )](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/vpc-interface-endpoints.html) in the *AWS CloudFormation User Guide* . > For Amazon EC2 and Auto Scaling resources, we recommend that you use a `CreationPolicy` attribute instead of wait conditions. Add a `CreationPolicy` attribute to those resources, and use the `cfn-signal` helper script to signal when an instance creation process has completed successfully.
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"
cfnWaitCondition := awscdk.Aws_cloudformation.NewCfnWaitCondition(this, jsii.String("MyCfnWaitCondition"), &CfnWaitConditionProps{
Count: jsii.Number(123),
Handle: jsii.String("handle"),
Timeout: jsii.String("timeout"),
})
func NewCfnWaitCondition ¶
func NewCfnWaitCondition(scope constructs.Construct, id *string, props *CfnWaitConditionProps) CfnWaitCondition
Create a new `AWS::CloudFormation::WaitCondition`.
type CfnWaitConditionHandle ¶
type CfnWaitConditionHandle interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawscloudformation.IWaitConditionHandleRef
// Returns a unique identifier for the resource.
AttrId() *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
Env() *interfaces.ResourceEnvironment
// 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{}
// A reference to a WaitConditionHandle resource.
WaitConditionHandleRef() *interfacesawscloudformation.WaitConditionHandleReference
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The `AWS::CloudFormation::WaitConditionHandle` type has no properties.
When you reference the `WaitConditionHandle` resource by using the `Ref` function, CloudFormation returns a presigned URL. You pass this URL to applications or scripts that are running on your Amazon EC2 instances to send signals to that URL. An associated `AWS::CloudFormation::WaitCondition` resource checks the URL for the required number of success signals or for a failure signal.
For more information, see [Create wait conditions in a CloudFormation template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-waitcondition.html) in the *AWS CloudFormation User Guide* .
Anytime you add a `WaitCondition` resource during a stack update or update a resource with a wait condition, you must associate the wait condition with a new `WaitConditionHandle` resource. Don't reuse an old wait condition handle that has already been defined in the template. If you reuse a wait condition handle, the wait condition might evaluate old signals from a previous create or update stack command.
Updates aren't supported for this resource.
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"
cfnWaitConditionHandle := awscdk.Aws_cloudformation.NewCfnWaitConditionHandle(this, jsii.String("MyCfnWaitConditionHandle"), &CfnWaitConditionHandleProps{
})
func NewCfnWaitConditionHandle ¶
func NewCfnWaitConditionHandle(scope constructs.Construct, id *string, props *CfnWaitConditionHandleProps) CfnWaitConditionHandle
Create a new `AWS::CloudFormation::WaitConditionHandle`.
type CfnWaitConditionHandleProps ¶ added in v2.88.0
type CfnWaitConditionHandleProps struct {
}
Properties for defining a `CfnWaitConditionHandle`.
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"
cfnWaitConditionHandleProps := &CfnWaitConditionHandleProps{
}
type CfnWaitConditionProps ¶
type CfnWaitConditionProps struct {
// The number of success signals that CloudFormation must receive before it continues the stack creation process.
//
// When the wait condition receives the requisite number of success signals, CloudFormation resumes the creation of the stack. If the wait condition doesn't receive the specified number of success signals before the Timeout period expires, CloudFormation assumes that the wait condition has failed and rolls the stack back.
//
// Updates aren't supported.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-waitcondition.html#cfn-cloudformation-waitcondition-count
//
Count *float64 `field:"optional" json:"count" yaml:"count"`
// A reference to the wait condition handle used to signal this wait condition.
//
// Use the `Ref` intrinsic function to specify an [AWS::CloudFormation::WaitConditionHandle](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-cloudformation-waitconditionhandle.html) resource.
//
// Anytime you add a `WaitCondition` resource during a stack update, you must associate the wait condition with a new WaitConditionHandle resource. Don't reuse an old wait condition handle that has already been defined in the template. If you reuse a wait condition handle, the wait condition might evaluate old signals from a previous create or update stack command.
//
// Updates aren't supported.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-waitcondition.html#cfn-cloudformation-waitcondition-handle
//
Handle *string `field:"optional" json:"handle" yaml:"handle"`
// The length of time (in seconds) to wait for the number of signals that the `Count` property specifies.
//
// `Timeout` is a minimum-bound property, meaning the timeout occurs no sooner than the time you specify, but can occur shortly thereafter. The maximum time that can be specified for this property is 12 hours (43200 seconds).
//
// Updates aren't supported.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-waitcondition.html#cfn-cloudformation-waitcondition-timeout
//
Timeout *string `field:"optional" json:"timeout" yaml:"timeout"`
}
Properties for defining a `CfnWaitCondition`.
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"
cfnWaitConditionProps := &CfnWaitConditionProps{
Count: jsii.Number(123),
Handle: jsii.String("handle"),
Timeout: jsii.String("timeout"),
}
Source Files
¶
- CfnCustomResource.go
- CfnCustomResourceProps.go
- CfnCustomResource__checks.go
- CfnGuardHook.go
- CfnGuardHookProps.go
- CfnGuardHook_HookTargetProperty.go
- CfnGuardHook_OptionsProperty.go
- CfnGuardHook_S3LocationProperty.go
- CfnGuardHook_StackFiltersProperty.go
- CfnGuardHook_StackNamesProperty.go
- CfnGuardHook_StackRolesProperty.go
- CfnGuardHook_TargetFiltersProperty.go
- CfnGuardHook__checks.go
- CfnHookDefaultVersion.go
- CfnHookDefaultVersionProps.go
- CfnHookDefaultVersion__checks.go
- CfnHookTypeConfig.go
- CfnHookTypeConfigProps.go
- CfnHookTypeConfig__checks.go
- CfnHookVersion.go
- CfnHookVersionProps.go
- CfnHookVersion_LoggingConfigProperty.go
- CfnHookVersion__checks.go
- CfnLambdaHook.go
- CfnLambdaHookProps.go
- CfnLambdaHook_HookTargetProperty.go
- CfnLambdaHook_StackFiltersProperty.go
- CfnLambdaHook_StackNamesProperty.go
- CfnLambdaHook_StackRolesProperty.go
- CfnLambdaHook_TargetFiltersProperty.go
- CfnLambdaHook__checks.go
- CfnMacro.go
- CfnMacroProps.go
- CfnMacro__checks.go
- CfnModuleDefaultVersion.go
- CfnModuleDefaultVersionProps.go
- CfnModuleDefaultVersion__checks.go
- CfnModuleVersion.go
- CfnModuleVersionProps.go
- CfnModuleVersion__checks.go
- CfnPublicTypeVersion.go
- CfnPublicTypeVersionProps.go
- CfnPublicTypeVersion__checks.go
- CfnPublisher.go
- CfnPublisherProps.go
- CfnPublisher__checks.go
- CfnResourceDefaultVersion.go
- CfnResourceDefaultVersionProps.go
- CfnResourceDefaultVersion__checks.go
- CfnResourceVersion.go
- CfnResourceVersionProps.go
- CfnResourceVersion_LoggingConfigProperty.go
- CfnResourceVersion__checks.go
- CfnStack.go
- CfnStackProps.go
- CfnStackSet.go
- CfnStackSetProps.go
- CfnStackSet_AutoDeploymentProperty.go
- CfnStackSet_DeploymentTargetsProperty.go
- CfnStackSet_ManagedExecutionProperty.go
- CfnStackSet_OperationPreferencesProperty.go
- CfnStackSet_ParameterProperty.go
- CfnStackSet_StackInstancesProperty.go
- CfnStackSet__checks.go
- CfnStack_OutputProperty.go
- CfnStack__checks.go
- CfnTypeActivation.go
- CfnTypeActivationProps.go
- CfnTypeActivation_LoggingConfigProperty.go
- CfnTypeActivation__checks.go
- CfnWaitCondition.go
- CfnWaitConditionHandle.go
- CfnWaitConditionHandleProps.go
- CfnWaitConditionHandle__checks.go
- CfnWaitConditionProps.go
- CfnWaitCondition__checks.go
- main.go