Documentation
¶
Index ¶
- func CfnAcceptedPortfolioShare_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAcceptedPortfolioShare_IsCfnElement(x interface{}) *bool
- func CfnAcceptedPortfolioShare_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnAcceptedPortfolioShare_IsConstruct(x interface{}) *bool
- func CfnCloudFormationProduct_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCloudFormationProduct_IsCfnElement(x interface{}) *bool
- func CfnCloudFormationProduct_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnCloudFormationProduct_IsConstruct(x interface{}) *bool
- func CfnCloudFormationProvisionedProduct_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCloudFormationProvisionedProduct_IsCfnElement(x interface{}) *bool
- func CfnCloudFormationProvisionedProduct_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnCloudFormationProvisionedProduct_IsConstruct(x interface{}) *bool
- func CfnLaunchNotificationConstraint_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLaunchNotificationConstraint_IsCfnElement(x interface{}) *bool
- func CfnLaunchNotificationConstraint_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnLaunchNotificationConstraint_IsConstruct(x interface{}) *bool
- func CfnLaunchRoleConstraint_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLaunchRoleConstraint_IsCfnElement(x interface{}) *bool
- func CfnLaunchRoleConstraint_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnLaunchRoleConstraint_IsConstruct(x interface{}) *bool
- func CfnLaunchTemplateConstraint_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLaunchTemplateConstraint_IsCfnElement(x interface{}) *bool
- func CfnLaunchTemplateConstraint_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnLaunchTemplateConstraint_IsConstruct(x interface{}) *bool
- func CfnPortfolioPrincipalAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPortfolioPrincipalAssociation_IsCfnElement(x interface{}) *bool
- func CfnPortfolioPrincipalAssociation_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnPortfolioPrincipalAssociation_IsConstruct(x interface{}) *bool
- func CfnPortfolioProductAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPortfolioProductAssociation_IsCfnElement(x interface{}) *bool
- func CfnPortfolioProductAssociation_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnPortfolioProductAssociation_IsConstruct(x interface{}) *bool
- func CfnPortfolioShare_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPortfolioShare_IsCfnElement(x interface{}) *bool
- func CfnPortfolioShare_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnPortfolioShare_IsConstruct(x interface{}) *bool
- func CfnPortfolio_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPortfolio_IsCfnElement(x interface{}) *bool
- func CfnPortfolio_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnPortfolio_IsConstruct(x interface{}) *bool
- func CfnResourceUpdateConstraint_CFN_RESOURCE_TYPE_NAME() *string
- func CfnResourceUpdateConstraint_IsCfnElement(x interface{}) *bool
- func CfnResourceUpdateConstraint_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnResourceUpdateConstraint_IsConstruct(x interface{}) *bool
- func CfnServiceActionAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnServiceActionAssociation_IsCfnElement(x interface{}) *bool
- func CfnServiceActionAssociation_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnServiceActionAssociation_IsConstruct(x interface{}) *bool
- func CfnServiceAction_CFN_RESOURCE_TYPE_NAME() *string
- func CfnServiceAction_IsCfnElement(x interface{}) *bool
- func CfnServiceAction_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnServiceAction_IsConstruct(x interface{}) *bool
- func CfnStackSetConstraint_CFN_RESOURCE_TYPE_NAME() *string
- func CfnStackSetConstraint_IsCfnElement(x interface{}) *bool
- func CfnStackSetConstraint_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnStackSetConstraint_IsConstruct(x interface{}) *bool
- func CfnTagOptionAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTagOptionAssociation_IsCfnElement(x interface{}) *bool
- func CfnTagOptionAssociation_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnTagOptionAssociation_IsConstruct(x interface{}) *bool
- func CfnTagOption_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTagOption_IsCfnElement(x interface{}) *bool
- func CfnTagOption_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnTagOption_IsConstruct(x interface{}) *bool
- func CloudFormationProduct_IsConstruct(x interface{}) *bool
- func CloudFormationProduct_IsOwnedResource(construct constructs.IConstruct) *bool
- func CloudFormationProduct_IsResource(construct constructs.IConstruct) *bool
- func NewCfnAcceptedPortfolioShare_Override(c CfnAcceptedPortfolioShare, scope constructs.Construct, id *string, ...)
- func NewCfnCloudFormationProduct_Override(c CfnCloudFormationProduct, scope constructs.Construct, id *string, ...)
- func NewCfnCloudFormationProvisionedProduct_Override(c CfnCloudFormationProvisionedProduct, scope constructs.Construct, id *string, ...)
- func NewCfnLaunchNotificationConstraint_Override(c CfnLaunchNotificationConstraint, scope constructs.Construct, id *string, ...)
- func NewCfnLaunchRoleConstraint_Override(c CfnLaunchRoleConstraint, scope constructs.Construct, id *string, ...)
- func NewCfnLaunchTemplateConstraint_Override(c CfnLaunchTemplateConstraint, scope constructs.Construct, id *string, ...)
- func NewCfnPortfolioPrincipalAssociation_Override(c CfnPortfolioPrincipalAssociation, scope constructs.Construct, id *string, ...)
- func NewCfnPortfolioProductAssociation_Override(c CfnPortfolioProductAssociation, scope constructs.Construct, id *string, ...)
- func NewCfnPortfolioShare_Override(c CfnPortfolioShare, scope constructs.Construct, id *string, ...)
- func NewCfnPortfolio_Override(c CfnPortfolio, scope constructs.Construct, id *string, ...)
- func NewCfnResourceUpdateConstraint_Override(c CfnResourceUpdateConstraint, scope constructs.Construct, id *string, ...)
- func NewCfnServiceActionAssociation_Override(c CfnServiceActionAssociation, scope constructs.Construct, id *string, ...)
- func NewCfnServiceAction_Override(c CfnServiceAction, scope constructs.Construct, id *string, ...)
- func NewCfnStackSetConstraint_Override(c CfnStackSetConstraint, scope constructs.Construct, id *string, ...)
- func NewCfnTagOptionAssociation_Override(c CfnTagOptionAssociation, scope constructs.Construct, id *string, ...)
- func NewCfnTagOption_Override(c CfnTagOption, scope constructs.Construct, id *string, ...)
- func NewCloudFormationProduct_Override(c CloudFormationProduct, scope constructs.Construct, id *string, ...)
- func NewCloudFormationTemplate_Override(c CloudFormationTemplate)
- func NewPortfolio_Override(p Portfolio, scope constructs.Construct, id *string, props *PortfolioProps)
- func NewProductStackHistory_Override(p ProductStackHistory, scope constructs.Construct, id *string, ...)
- func NewProductStack_Override(p ProductStack, scope constructs.Construct, id *string, ...)
- func NewProduct_Override(p Product, scope constructs.Construct, id *string, props *awscdk.ResourceProps)
- func NewTagOptions_Override(t TagOptions, scope constructs.Construct, id *string, props *TagOptionsProps)
- func Portfolio_IsConstruct(x interface{}) *bool
- func Portfolio_IsOwnedResource(construct constructs.IConstruct) *bool
- func Portfolio_IsResource(construct constructs.IConstruct) *bool
- func ProductStackHistory_IsConstruct(x interface{}) *bool
- func ProductStack_IsConstruct(x interface{}) *bool
- func ProductStack_IsStack(x interface{}) *bool
- func ProductStack_Of(construct constructs.IConstruct) awscdk.Stack
- func Product_IsConstruct(x interface{}) *bool
- func Product_IsOwnedResource(construct constructs.IConstruct) *bool
- func Product_IsResource(construct constructs.IConstruct) *bool
- func TagOptions_IsConstruct(x interface{}) *bool
- func TagOptions_IsOwnedResource(construct constructs.IConstruct) *bool
- func TagOptions_IsResource(construct constructs.IConstruct) *bool
- type CfnAcceptedPortfolioShare
- type CfnAcceptedPortfolioShareProps
- type CfnCloudFormationProduct
- type CfnCloudFormationProductProps
- type CfnCloudFormationProduct_CodeStarParametersProperty
- type CfnCloudFormationProduct_ConnectionParametersProperty
- type CfnCloudFormationProduct_ProvisioningArtifactPropertiesProperty
- type CfnCloudFormationProduct_SourceConnectionProperty
- type CfnCloudFormationProvisionedProduct
- type CfnCloudFormationProvisionedProductProps
- type CfnCloudFormationProvisionedProduct_ProvisioningParameterProperty
- type CfnCloudFormationProvisionedProduct_ProvisioningPreferencesProperty
- type CfnLaunchNotificationConstraint
- type CfnLaunchNotificationConstraintProps
- type CfnLaunchRoleConstraint
- type CfnLaunchRoleConstraintProps
- type CfnLaunchTemplateConstraint
- type CfnLaunchTemplateConstraintProps
- type CfnPortfolio
- type CfnPortfolioPrincipalAssociation
- type CfnPortfolioPrincipalAssociationProps
- type CfnPortfolioProductAssociation
- type CfnPortfolioProductAssociationProps
- type CfnPortfolioProps
- type CfnPortfolioShare
- type CfnPortfolioShareProps
- type CfnResourceUpdateConstraint
- type CfnResourceUpdateConstraintProps
- type CfnServiceAction
- type CfnServiceActionAssociation
- type CfnServiceActionAssociationProps
- type CfnServiceActionProps
- type CfnServiceAction_DefinitionParameterProperty
- type CfnStackSetConstraint
- type CfnStackSetConstraintProps
- type CfnTagOption
- type CfnTagOptionAssociation
- type CfnTagOptionAssociationProps
- type CfnTagOptionProps
- type CloudFormationProduct
- type CloudFormationProductProps
- type CloudFormationProductVersion
- type CloudFormationRuleConstraintOptions
- type CloudFormationTemplate
- type CloudFormationTemplateConfig
- type CommonConstraintOptions
- type IPortfolio
- type IProduct
- type MessageLanguage
- type Portfolio
- type PortfolioProps
- type PortfolioShareOptions
- type Product
- type ProductStack
- type ProductStackHistory
- type ProductStackHistoryProps
- type ProductStackProps
- type StackSetsConstraintOptions
- type TagOptions
- type TagOptionsProps
- type TagUpdateConstraintOptions
- type TemplateRule
- type TemplateRuleAssertion
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnAcceptedPortfolioShare_CFN_RESOURCE_TYPE_NAME ¶
func CfnAcceptedPortfolioShare_CFN_RESOURCE_TYPE_NAME() *string
func CfnAcceptedPortfolioShare_IsCfnElement ¶
func CfnAcceptedPortfolioShare_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 CfnAcceptedPortfolioShare_IsCfnResource ¶
func CfnAcceptedPortfolioShare_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnAcceptedPortfolioShare_IsConstruct ¶
func CfnAcceptedPortfolioShare_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 CfnCloudFormationProduct_CFN_RESOURCE_TYPE_NAME ¶
func CfnCloudFormationProduct_CFN_RESOURCE_TYPE_NAME() *string
func CfnCloudFormationProduct_IsCfnElement ¶
func CfnCloudFormationProduct_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 CfnCloudFormationProduct_IsCfnResource ¶
func CfnCloudFormationProduct_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnCloudFormationProduct_IsConstruct ¶
func CfnCloudFormationProduct_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 CfnCloudFormationProvisionedProduct_CFN_RESOURCE_TYPE_NAME ¶
func CfnCloudFormationProvisionedProduct_CFN_RESOURCE_TYPE_NAME() *string
func CfnCloudFormationProvisionedProduct_IsCfnElement ¶
func CfnCloudFormationProvisionedProduct_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 CfnCloudFormationProvisionedProduct_IsCfnResource ¶
func CfnCloudFormationProvisionedProduct_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnCloudFormationProvisionedProduct_IsConstruct ¶
func CfnCloudFormationProvisionedProduct_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 CfnLaunchNotificationConstraint_CFN_RESOURCE_TYPE_NAME ¶
func CfnLaunchNotificationConstraint_CFN_RESOURCE_TYPE_NAME() *string
func CfnLaunchNotificationConstraint_IsCfnElement ¶
func CfnLaunchNotificationConstraint_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 CfnLaunchNotificationConstraint_IsCfnResource ¶
func CfnLaunchNotificationConstraint_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnLaunchNotificationConstraint_IsConstruct ¶
func CfnLaunchNotificationConstraint_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 CfnLaunchRoleConstraint_CFN_RESOURCE_TYPE_NAME ¶
func CfnLaunchRoleConstraint_CFN_RESOURCE_TYPE_NAME() *string
func CfnLaunchRoleConstraint_IsCfnElement ¶
func CfnLaunchRoleConstraint_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 CfnLaunchRoleConstraint_IsCfnResource ¶
func CfnLaunchRoleConstraint_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnLaunchRoleConstraint_IsConstruct ¶
func CfnLaunchRoleConstraint_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 CfnLaunchTemplateConstraint_CFN_RESOURCE_TYPE_NAME ¶
func CfnLaunchTemplateConstraint_CFN_RESOURCE_TYPE_NAME() *string
func CfnLaunchTemplateConstraint_IsCfnElement ¶
func CfnLaunchTemplateConstraint_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 CfnLaunchTemplateConstraint_IsCfnResource ¶
func CfnLaunchTemplateConstraint_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnLaunchTemplateConstraint_IsConstruct ¶
func CfnLaunchTemplateConstraint_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 CfnPortfolioPrincipalAssociation_CFN_RESOURCE_TYPE_NAME ¶
func CfnPortfolioPrincipalAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnPortfolioPrincipalAssociation_IsCfnElement ¶
func CfnPortfolioPrincipalAssociation_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 CfnPortfolioPrincipalAssociation_IsCfnResource ¶
func CfnPortfolioPrincipalAssociation_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnPortfolioPrincipalAssociation_IsConstruct ¶
func CfnPortfolioPrincipalAssociation_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 CfnPortfolioProductAssociation_CFN_RESOURCE_TYPE_NAME ¶
func CfnPortfolioProductAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnPortfolioProductAssociation_IsCfnElement ¶
func CfnPortfolioProductAssociation_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 CfnPortfolioProductAssociation_IsCfnResource ¶
func CfnPortfolioProductAssociation_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnPortfolioProductAssociation_IsConstruct ¶
func CfnPortfolioProductAssociation_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 CfnPortfolioShare_CFN_RESOURCE_TYPE_NAME ¶
func CfnPortfolioShare_CFN_RESOURCE_TYPE_NAME() *string
func CfnPortfolioShare_IsCfnElement ¶
func CfnPortfolioShare_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 CfnPortfolioShare_IsCfnResource ¶
func CfnPortfolioShare_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnPortfolioShare_IsConstruct ¶
func CfnPortfolioShare_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 CfnPortfolio_CFN_RESOURCE_TYPE_NAME ¶
func CfnPortfolio_CFN_RESOURCE_TYPE_NAME() *string
func CfnPortfolio_IsCfnElement ¶
func CfnPortfolio_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 CfnPortfolio_IsCfnResource ¶
func CfnPortfolio_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnPortfolio_IsConstruct ¶
func CfnPortfolio_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 CfnResourceUpdateConstraint_CFN_RESOURCE_TYPE_NAME ¶
func CfnResourceUpdateConstraint_CFN_RESOURCE_TYPE_NAME() *string
func CfnResourceUpdateConstraint_IsCfnElement ¶
func CfnResourceUpdateConstraint_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 CfnResourceUpdateConstraint_IsCfnResource ¶
func CfnResourceUpdateConstraint_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnResourceUpdateConstraint_IsConstruct ¶
func CfnResourceUpdateConstraint_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 CfnServiceActionAssociation_CFN_RESOURCE_TYPE_NAME ¶
func CfnServiceActionAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnServiceActionAssociation_IsCfnElement ¶
func CfnServiceActionAssociation_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 CfnServiceActionAssociation_IsCfnResource ¶
func CfnServiceActionAssociation_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnServiceActionAssociation_IsConstruct ¶
func CfnServiceActionAssociation_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 CfnServiceAction_CFN_RESOURCE_TYPE_NAME ¶
func CfnServiceAction_CFN_RESOURCE_TYPE_NAME() *string
func CfnServiceAction_IsCfnElement ¶
func CfnServiceAction_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 CfnServiceAction_IsCfnResource ¶
func CfnServiceAction_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnServiceAction_IsConstruct ¶
func CfnServiceAction_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 CfnStackSetConstraint_CFN_RESOURCE_TYPE_NAME ¶
func CfnStackSetConstraint_CFN_RESOURCE_TYPE_NAME() *string
func CfnStackSetConstraint_IsCfnElement ¶
func CfnStackSetConstraint_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 CfnStackSetConstraint_IsCfnResource ¶
func CfnStackSetConstraint_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnStackSetConstraint_IsConstruct ¶
func CfnStackSetConstraint_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 CfnTagOptionAssociation_CFN_RESOURCE_TYPE_NAME ¶
func CfnTagOptionAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnTagOptionAssociation_IsCfnElement ¶
func CfnTagOptionAssociation_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 CfnTagOptionAssociation_IsCfnResource ¶
func CfnTagOptionAssociation_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnTagOptionAssociation_IsConstruct ¶
func CfnTagOptionAssociation_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 CfnTagOption_CFN_RESOURCE_TYPE_NAME ¶
func CfnTagOption_CFN_RESOURCE_TYPE_NAME() *string
func CfnTagOption_IsCfnElement ¶
func CfnTagOption_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 CfnTagOption_IsCfnResource ¶
func CfnTagOption_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnTagOption_IsConstruct ¶
func CfnTagOption_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 CloudFormationProduct_IsConstruct ¶ added in v2.23.0
func CloudFormationProduct_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 CloudFormationProduct_IsOwnedResource ¶ added in v2.32.0
func CloudFormationProduct_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func CloudFormationProduct_IsResource ¶ added in v2.23.0
func CloudFormationProduct_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func NewCfnAcceptedPortfolioShare_Override ¶
func NewCfnAcceptedPortfolioShare_Override(c CfnAcceptedPortfolioShare, scope constructs.Construct, id *string, props *CfnAcceptedPortfolioShareProps)
Create a new `AWS::ServiceCatalog::AcceptedPortfolioShare`.
func NewCfnCloudFormationProduct_Override ¶
func NewCfnCloudFormationProduct_Override(c CfnCloudFormationProduct, scope constructs.Construct, id *string, props *CfnCloudFormationProductProps)
Create a new `AWS::ServiceCatalog::CloudFormationProduct`.
func NewCfnCloudFormationProvisionedProduct_Override ¶
func NewCfnCloudFormationProvisionedProduct_Override(c CfnCloudFormationProvisionedProduct, scope constructs.Construct, id *string, props *CfnCloudFormationProvisionedProductProps)
Create a new `AWS::ServiceCatalog::CloudFormationProvisionedProduct`.
func NewCfnLaunchNotificationConstraint_Override ¶
func NewCfnLaunchNotificationConstraint_Override(c CfnLaunchNotificationConstraint, scope constructs.Construct, id *string, props *CfnLaunchNotificationConstraintProps)
Create a new `AWS::ServiceCatalog::LaunchNotificationConstraint`.
func NewCfnLaunchRoleConstraint_Override ¶
func NewCfnLaunchRoleConstraint_Override(c CfnLaunchRoleConstraint, scope constructs.Construct, id *string, props *CfnLaunchRoleConstraintProps)
Create a new `AWS::ServiceCatalog::LaunchRoleConstraint`.
func NewCfnLaunchTemplateConstraint_Override ¶
func NewCfnLaunchTemplateConstraint_Override(c CfnLaunchTemplateConstraint, scope constructs.Construct, id *string, props *CfnLaunchTemplateConstraintProps)
Create a new `AWS::ServiceCatalog::LaunchTemplateConstraint`.
func NewCfnPortfolioPrincipalAssociation_Override ¶
func NewCfnPortfolioPrincipalAssociation_Override(c CfnPortfolioPrincipalAssociation, scope constructs.Construct, id *string, props *CfnPortfolioPrincipalAssociationProps)
Create a new `AWS::ServiceCatalog::PortfolioPrincipalAssociation`.
func NewCfnPortfolioProductAssociation_Override ¶
func NewCfnPortfolioProductAssociation_Override(c CfnPortfolioProductAssociation, scope constructs.Construct, id *string, props *CfnPortfolioProductAssociationProps)
Create a new `AWS::ServiceCatalog::PortfolioProductAssociation`.
func NewCfnPortfolioShare_Override ¶
func NewCfnPortfolioShare_Override(c CfnPortfolioShare, scope constructs.Construct, id *string, props *CfnPortfolioShareProps)
Create a new `AWS::ServiceCatalog::PortfolioShare`.
func NewCfnPortfolio_Override ¶
func NewCfnPortfolio_Override(c CfnPortfolio, scope constructs.Construct, id *string, props *CfnPortfolioProps)
Create a new `AWS::ServiceCatalog::Portfolio`.
func NewCfnResourceUpdateConstraint_Override ¶
func NewCfnResourceUpdateConstraint_Override(c CfnResourceUpdateConstraint, scope constructs.Construct, id *string, props *CfnResourceUpdateConstraintProps)
Create a new `AWS::ServiceCatalog::ResourceUpdateConstraint`.
func NewCfnServiceActionAssociation_Override ¶
func NewCfnServiceActionAssociation_Override(c CfnServiceActionAssociation, scope constructs.Construct, id *string, props *CfnServiceActionAssociationProps)
Create a new `AWS::ServiceCatalog::ServiceActionAssociation`.
func NewCfnServiceAction_Override ¶
func NewCfnServiceAction_Override(c CfnServiceAction, scope constructs.Construct, id *string, props *CfnServiceActionProps)
Create a new `AWS::ServiceCatalog::ServiceAction`.
func NewCfnStackSetConstraint_Override ¶
func NewCfnStackSetConstraint_Override(c CfnStackSetConstraint, scope constructs.Construct, id *string, props *CfnStackSetConstraintProps)
Create a new `AWS::ServiceCatalog::StackSetConstraint`.
func NewCfnTagOptionAssociation_Override ¶
func NewCfnTagOptionAssociation_Override(c CfnTagOptionAssociation, scope constructs.Construct, id *string, props *CfnTagOptionAssociationProps)
Create a new `AWS::ServiceCatalog::TagOptionAssociation`.
func NewCfnTagOption_Override ¶
func NewCfnTagOption_Override(c CfnTagOption, scope constructs.Construct, id *string, props *CfnTagOptionProps)
Create a new `AWS::ServiceCatalog::TagOption`.
func NewCloudFormationProduct_Override ¶ added in v2.23.0
func NewCloudFormationProduct_Override(c CloudFormationProduct, scope constructs.Construct, id *string, props *CloudFormationProductProps)
func NewCloudFormationTemplate_Override ¶ added in v2.23.0
func NewCloudFormationTemplate_Override(c CloudFormationTemplate)
func NewPortfolio_Override ¶ added in v2.23.0
func NewPortfolio_Override(p Portfolio, scope constructs.Construct, id *string, props *PortfolioProps)
func NewProductStackHistory_Override ¶ added in v2.26.0
func NewProductStackHistory_Override(p ProductStackHistory, scope constructs.Construct, id *string, props *ProductStackHistoryProps)
func NewProductStack_Override ¶ added in v2.23.0
func NewProductStack_Override(p ProductStack, scope constructs.Construct, id *string, props *ProductStackProps)
func NewProduct_Override ¶ added in v2.23.0
func NewProduct_Override(p Product, scope constructs.Construct, id *string, props *awscdk.ResourceProps)
func NewTagOptions_Override ¶ added in v2.23.0
func NewTagOptions_Override(t TagOptions, scope constructs.Construct, id *string, props *TagOptionsProps)
func Portfolio_IsConstruct ¶ added in v2.23.0
func Portfolio_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 Portfolio_IsOwnedResource ¶ added in v2.32.0
func Portfolio_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func Portfolio_IsResource ¶ added in v2.23.0
func Portfolio_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func ProductStackHistory_IsConstruct ¶ added in v2.26.0
func ProductStackHistory_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 ProductStack_IsConstruct ¶ added in v2.23.0
func ProductStack_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 ProductStack_IsStack ¶ added in v2.23.0
func ProductStack_IsStack(x interface{}) *bool
Return whether the given object is a Stack.
We do attribute detection since we can't reliably use 'instanceof'.
func ProductStack_Of ¶ added in v2.23.0
func ProductStack_Of(construct constructs.IConstruct) awscdk.Stack
Looks up the first stack scope in which `construct` is defined.
Fails if there is no stack up the tree.
func Product_IsConstruct ¶ added in v2.23.0
func Product_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 Product_IsOwnedResource ¶ added in v2.32.0
func Product_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func Product_IsResource ¶ added in v2.23.0
func Product_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func TagOptions_IsConstruct ¶ added in v2.23.0
func TagOptions_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 TagOptions_IsOwnedResource ¶ added in v2.32.0
func TagOptions_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func TagOptions_IsResource ¶ added in v2.23.0
func TagOptions_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
Types ¶
type CfnAcceptedPortfolioShare ¶
type CfnAcceptedPortfolioShare interface {
awscdk.CfnResource
awscdk.IInspectable
// The language code.
//
// - `jp` - Japanese
// - `zh` - Chinese.
// Options for this resource, such as condition, update policy etc.
CfnResourceType() *string
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
//
// 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
Node() constructs.Node
// The portfolio identifier.
//
// 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
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// 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{}
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
AddDeletionOverride(path *string)
//
// 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)
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// 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{})
//
// 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{})
AddPropertyDeletionOverride(propertyPath *string)
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
//
// 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)
//
// 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
// 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{}
Inspect(inspector awscdk.TreeInspector)
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
ObtainResourceDependencies() *[]awscdk.CfnResource
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.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
//
// 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.
}
A CloudFormation `AWS::ServiceCatalog::AcceptedPortfolioShare`.
Accepts an offer to share the specified portfolio.
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"
cfnAcceptedPortfolioShare := awscdk.Aws_servicecatalog.NewCfnAcceptedPortfolioShare(this, jsii.String("MyCfnAcceptedPortfolioShare"), &CfnAcceptedPortfolioShareProps{
PortfolioId: jsii.String("portfolioId"),
// the properties below are optional
AcceptLanguage: jsii.String("acceptLanguage"),
})
func NewCfnAcceptedPortfolioShare ¶
func NewCfnAcceptedPortfolioShare(scope constructs.Construct, id *string, props *CfnAcceptedPortfolioShareProps) CfnAcceptedPortfolioShare
Create a new `AWS::ServiceCatalog::AcceptedPortfolioShare`.
type CfnAcceptedPortfolioShareProps ¶
type CfnAcceptedPortfolioShareProps struct {
PortfolioId *string `field:"required" json:"portfolioId" yaml:"portfolioId"`
//
// - `jp` - Japanese
// - `zh` - Chinese.
AcceptLanguage *string `field:"optional" json:"acceptLanguage" yaml:"acceptLanguage"`
}
Properties for defining a `CfnAcceptedPortfolioShare`.
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"
cfnAcceptedPortfolioShareProps := &CfnAcceptedPortfolioShareProps{
PortfolioId: jsii.String("portfolioId"),
// the properties below are optional
AcceptLanguage: jsii.String("acceptLanguage"),
}
type CfnCloudFormationProduct ¶
type CfnCloudFormationProduct interface {
awscdk.CfnResource
awscdk.IInspectable
// The language code.
//
// - `jp` - Japanese
// - `zh` - Chinese.
AcceptLanguage() *string
SetAcceptLanguage(val *string)
// The name of the product.
AttrProductName() *string
// The IDs of the provisioning artifacts.
AttrProvisioningArtifactIds() *string
// The names of the provisioning artifacts.
AttrProvisioningArtifactNames() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The description of the product.
Description() *string
SetDescription(val *string)
// The distributor of the product.
Distributor() *string
SetDistributor(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The name of the product.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// The owner of the product.
Owner() *string
SetOwner(val *string)
// The type of product.
ProductType() *string
SetProductType(val *string)
// The configuration of the provisioning artifact (also known as a version).
ProvisioningArtifactParameters() interface{}
SetProvisioningArtifactParameters(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
// This property is turned off by default.
//
// If turned off, you can update provisioning artifacts or product attributes (such as description, distributor, name, owner, and more) and the associated provisioning artifacts will retain the same unique identifier. Provisioning artifacts are matched within the CloudFormationProduct resource, and only those that have been updated will be changed. Provisioning artifacts are matched by a combinaton of provisioning artifact template URL and name.
//
// If turned on, provisioning artifacts will be given a new unique identifier when you update the product or provisioning artifacts.
ReplaceProvisioningArtifacts() interface{}
SetReplaceProvisioningArtifacts(val interface{})
// A top level `ProductViewDetail` response containing details about the product’s connection.
//
// AWS Service Catalog returns this field for the `CreateProduct` , `UpdateProduct` , `DescribeProductAsAdmin` , and `SearchProductAsAdmin` APIs. This response contains the same fields as the `ConnectionParameters` request, with the addition of the `LastSync` response.
SourceConnection() interface{}
SetSourceConnection(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The support information about the product.
SupportDescription() *string
SetSupportDescription(val *string)
// The contact email for product support.
SupportEmail() *string
SetSupportEmail(val *string)
// The contact URL for product support.
//
// `^https?:\/\//` / is the pattern used to validate SupportUrl.
SupportUrl() *string
SetSupportUrl(val *string)
// One or more tags.
Tags() awscdk.TagManager
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ServiceCatalog::CloudFormationProduct`.
Specifies a product.
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 info interface{}
cfnCloudFormationProduct := awscdk.Aws_servicecatalog.NewCfnCloudFormationProduct(this, jsii.String("MyCfnCloudFormationProduct"), &CfnCloudFormationProductProps{
Name: jsii.String("name"),
Owner: jsii.String("owner"),
// the properties below are optional
AcceptLanguage: jsii.String("acceptLanguage"),
Description: jsii.String("description"),
Distributor: jsii.String("distributor"),
ProductType: jsii.String("productType"),
ProvisioningArtifactParameters: []interface{}{
&ProvisioningArtifactPropertiesProperty{
Info: info,
// the properties below are optional
Description: jsii.String("description"),
DisableTemplateValidation: jsii.Boolean(false),
Name: jsii.String("name"),
Type: jsii.String("type"),
},
},
ReplaceProvisioningArtifacts: jsii.Boolean(false),
SourceConnection: &SourceConnectionProperty{
ConnectionParameters: &ConnectionParametersProperty{
CodeStar: &CodeStarParametersProperty{
ArtifactPath: jsii.String("artifactPath"),
Branch: jsii.String("branch"),
ConnectionArn: jsii.String("connectionArn"),
Repository: jsii.String("repository"),
},
},
Type: jsii.String("type"),
},
SupportDescription: jsii.String("supportDescription"),
SupportEmail: jsii.String("supportEmail"),
SupportUrl: jsii.String("supportUrl"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnCloudFormationProduct ¶
func NewCfnCloudFormationProduct(scope constructs.Construct, id *string, props *CfnCloudFormationProductProps) CfnCloudFormationProduct
Create a new `AWS::ServiceCatalog::CloudFormationProduct`.
type CfnCloudFormationProductProps ¶
type CfnCloudFormationProductProps struct {
// The name of the product.
Name *string `field:"required" json:"name" yaml:"name"`
// The owner of the product.
Owner *string `field:"required" json:"owner" yaml:"owner"`
// The language code.
//
// - `jp` - Japanese
// - `zh` - Chinese.
AcceptLanguage *string `field:"optional" json:"acceptLanguage" yaml:"acceptLanguage"`
// The description of the product.
Description *string `field:"optional" json:"description" yaml:"description"`
// The distributor of the product.
Distributor *string `field:"optional" json:"distributor" yaml:"distributor"`
// The type of product.
ProductType *string `field:"optional" json:"productType" yaml:"productType"`
// The configuration of the provisioning artifact (also known as a version).
ProvisioningArtifactParameters interface{} `field:"optional" json:"provisioningArtifactParameters" yaml:"provisioningArtifactParameters"`
// This property is turned off by default.
//
// If turned off, you can update provisioning artifacts or product attributes (such as description, distributor, name, owner, and more) and the associated provisioning artifacts will retain the same unique identifier. Provisioning artifacts are matched within the CloudFormationProduct resource, and only those that have been updated will be changed. Provisioning artifacts are matched by a combinaton of provisioning artifact template URL and name.
//
// If turned on, provisioning artifacts will be given a new unique identifier when you update the product or provisioning artifacts.
ReplaceProvisioningArtifacts interface{} `field:"optional" json:"replaceProvisioningArtifacts" yaml:"replaceProvisioningArtifacts"`
// A top level `ProductViewDetail` response containing details about the product’s connection.
//
// AWS Service Catalog returns this field for the `CreateProduct` , `UpdateProduct` , `DescribeProductAsAdmin` , and `SearchProductAsAdmin` APIs. This response contains the same fields as the `ConnectionParameters` request, with the addition of the `LastSync` response.
SourceConnection interface{} `field:"optional" json:"sourceConnection" yaml:"sourceConnection"`
// The support information about the product.
SupportDescription *string `field:"optional" json:"supportDescription" yaml:"supportDescription"`
// The contact email for product support.
SupportEmail *string `field:"optional" json:"supportEmail" yaml:"supportEmail"`
// The contact URL for product support.
//
// `^https?:\/\//` / is the pattern used to validate SupportUrl.
SupportUrl *string `field:"optional" json:"supportUrl" yaml:"supportUrl"`
// One or more tags.
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnCloudFormationProduct`.
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 info interface{}
cfnCloudFormationProductProps := &CfnCloudFormationProductProps{
Name: jsii.String("name"),
Owner: jsii.String("owner"),
// the properties below are optional
AcceptLanguage: jsii.String("acceptLanguage"),
Description: jsii.String("description"),
Distributor: jsii.String("distributor"),
ProductType: jsii.String("productType"),
ProvisioningArtifactParameters: []interface{}{
&ProvisioningArtifactPropertiesProperty{
Info: info,
// the properties below are optional
Description: jsii.String("description"),
DisableTemplateValidation: jsii.Boolean(false),
Name: jsii.String("name"),
Type: jsii.String("type"),
},
},
ReplaceProvisioningArtifacts: jsii.Boolean(false),
SourceConnection: &SourceConnectionProperty{
ConnectionParameters: &ConnectionParametersProperty{
CodeStar: &CodeStarParametersProperty{
ArtifactPath: jsii.String("artifactPath"),
Branch: jsii.String("branch"),
ConnectionArn: jsii.String("connectionArn"),
Repository: jsii.String("repository"),
},
},
Type: jsii.String("type"),
},
SupportDescription: jsii.String("supportDescription"),
SupportEmail: jsii.String("supportEmail"),
SupportUrl: jsii.String("supportUrl"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnCloudFormationProduct_CodeStarParametersProperty ¶ added in v2.70.0
type CfnCloudFormationProduct_CodeStarParametersProperty struct {
// The absolute path wehre the artifact resides within the repo and branch, formatted as "folder/file.json.".
ArtifactPath *string `field:"required" json:"artifactPath" yaml:"artifactPath"`
// The specific branch where the artifact resides.
Branch *string `field:"required" json:"branch" yaml:"branch"`
// The CodeStar ARN, which is the connection between AWS Service Catalog and the external repository.
ConnectionArn *string `field:"required" json:"connectionArn" yaml:"connectionArn"`
// The specific repository where the product’s artifact-to-be-synced resides, formatted as "Account/Repo.".
Repository *string `field:"required" json:"repository" yaml:"repository"`
}
The subtype containing details about the Codestar connection `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"
codeStarParametersProperty := &CodeStarParametersProperty{
ArtifactPath: jsii.String("artifactPath"),
Branch: jsii.String("branch"),
ConnectionArn: jsii.String("connectionArn"),
Repository: jsii.String("repository"),
}
type CfnCloudFormationProduct_ConnectionParametersProperty ¶ added in v2.70.0
type CfnCloudFormationProduct_ConnectionParametersProperty struct {
// Provides `ConnectionType` details.
CodeStar interface{} `field:"optional" json:"codeStar" yaml:"codeStar"`
}
Provides connection details.
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"
connectionParametersProperty := &ConnectionParametersProperty{
CodeStar: &CodeStarParametersProperty{
ArtifactPath: jsii.String("artifactPath"),
Branch: jsii.String("branch"),
ConnectionArn: jsii.String("connectionArn"),
Repository: jsii.String("repository"),
},
}
type CfnCloudFormationProduct_ProvisioningArtifactPropertiesProperty ¶
type CfnCloudFormationProduct_ProvisioningArtifactPropertiesProperty struct {
// Specify the template source with one of the following options, but not both.
//
// Keys accepted: [ `LoadTemplateFromURL` , `ImportFromPhysicalId` ]
//
// The URL of the AWS CloudFormation template in Amazon S3 in JSON format. Specify the URL in JSON format as follows:
//
// `"LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."`
//
// `ImportFromPhysicalId` : The physical id of the resource that contains the template. Currently only supports AWS CloudFormation stack arn. Specify the physical id in JSON format as follows: `ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]`
Info interface{} `field:"required" json:"info" yaml:"info"`
// The description of the provisioning artifact, including how it differs from the previous provisioning artifact.
Description *string `field:"optional" json:"description" yaml:"description"`
// If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid.
DisableTemplateValidation interface{} `field:"optional" json:"disableTemplateValidation" yaml:"disableTemplateValidation"`
// The name of the provisioning artifact (for example, v1 v2beta).
//
// No spaces are allowed.
Name *string `field:"optional" json:"name" yaml:"name"`
// The type of provisioning artifact.
//
// - `CLOUD_FORMATION_TEMPLATE` - AWS CloudFormation template
// - `MARKETPLACE_AMI` - AWS Marketplace AMI
// - `MARKETPLACE_CAR` - AWS Marketplace Clusters and AWS Resources
// - `TERRAFORM_OPEN_SOURCE` - Terraform open source configuration file.
Type *string `field:"optional" json:"type" yaml:"type"`
}
Information about a provisioning artifact (also known as a version) for a product.
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 info interface{}
provisioningArtifactPropertiesProperty := &ProvisioningArtifactPropertiesProperty{
Info: info,
// the properties below are optional
Description: jsii.String("description"),
DisableTemplateValidation: jsii.Boolean(false),
Name: jsii.String("name"),
Type: jsii.String("type"),
}
type CfnCloudFormationProduct_SourceConnectionProperty ¶ added in v2.70.0
type CfnCloudFormationProduct_SourceConnectionProperty struct {
// The connection details based on the connection `Type` .
ConnectionParameters interface{} `field:"required" json:"connectionParameters" yaml:"connectionParameters"`
// The only supported `SourceConnection` type is Codestar.
Type *string `field:"required" json:"type" yaml:"type"`
}
A top level `ProductViewDetail` response containing details about the product’s connection.
AWS Service Catalog returns this field for the `CreateProduct` , `UpdateProduct` , `DescribeProductAsAdmin` , and `SearchProductAsAdmin` APIs. This response contains the same fields as the `ConnectionParameters` request, with the addition of the `LastSync` response.
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"
sourceConnectionProperty := &SourceConnectionProperty{
ConnectionParameters: &ConnectionParametersProperty{
CodeStar: &CodeStarParametersProperty{
ArtifactPath: jsii.String("artifactPath"),
Branch: jsii.String("branch"),
ConnectionArn: jsii.String("connectionArn"),
Repository: jsii.String("repository"),
},
},
Type: jsii.String("type"),
}
type CfnCloudFormationProvisionedProduct ¶
type CfnCloudFormationProvisionedProduct interface {
awscdk.CfnResource
awscdk.IInspectable
// The language code.
//
// - `jp` - Japanese
// - `zh` - Chinese.
AcceptLanguage() *string
SetAcceptLanguage(val *string)
// The Amazon Resource Name (ARN) of the CloudFormation stack, such as `arn:aws:cloudformation:eu-west-1:123456789012:stack/SC-499278721343-pp-hfyszaotincww/8f3df460-346a-11e8-9444-503abe701c29` .
AttrCloudformationStackArn() *string
// The output of the product you are provisioning.
//
// For example, the DNS of an EC2 instance.
AttrOutputs() awscdk.IResolvable
// The ID of the provisioned product.
AttrProvisionedProductId() *string
// The ID of the record, such as `rec-rjeatvy434trk` .
AttrRecordId() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The 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
// Passed to AWS CloudFormation .
//
// The SNS topic ARNs to which to publish stack-related events.
NotificationArns() *[]*string
SetNotificationArns(val *[]*string)
// The path identifier of the product.
//
// This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use [ListLaunchPaths](https://docs.aws.amazon.com/servicecatalog/latest/dg/API_ListLaunchPaths.html) .
//
// > You must provide the name or ID, but not both.
PathId() *string
SetPathId(val *string)
// The name of the path.
//
// This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use [ListLaunchPaths](https://docs.aws.amazon.com/servicecatalog/latest/dg/API_ListLaunchPaths.html) .
//
// > You must provide the name or ID, but not both.
PathName() *string
SetPathName(val *string)
// The product identifier.
//
// > You must specify either the ID or the name of the product, but not both.
ProductId() *string
SetProductId(val *string)
// The name of the Service Catalog product.
//
// Each time a stack is created or updated, if `ProductName` is provided it will successfully resolve to `ProductId` as long as only one product exists in the account or Region with that `ProductName` .
//
// > You must specify either the name or the ID of the product, but not both.
ProductName() *string
SetProductName(val *string)
// A user-friendly name for the provisioned product.
//
// This value must be unique for the AWS account and cannot be updated after the product is provisioned.
ProvisionedProductName() *string
SetProvisionedProductName(val *string)
// The identifier of the provisioning artifact (also known as a version).
//
// > You must specify either the ID or the name of the provisioning artifact, but not both.
ProvisioningArtifactId() *string
SetProvisioningArtifactId(val *string)
// The name of the provisioning artifact (also known as a version) for the product.
//
// This name must be unique for the product.
//
// > You must specify either the name or the ID of the provisioning artifact, but not both. You must also specify either the name or the ID of the product, but not both.
ProvisioningArtifactName() *string
SetProvisioningArtifactName(val *string)
// Parameters specified by the administrator that are required for provisioning the product.
ProvisioningParameters() interface{}
SetProvisioningParameters(val interface{})
// StackSet preferences that are required for provisioning the product or updating a provisioned product.
ProvisioningPreferences() interface{}
SetProvisioningPreferences(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
// One or more tags.
//
// > Requires the provisioned product to have an [ResourceUpdateConstraint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-resourceupdateconstraint.html) resource with `TagUpdatesOnProvisionedProduct` set to `ALLOWED` to allow tag updates. If `RESOURCE_UPDATE` constraint is not present, tags updates are ignored.
Tags() awscdk.TagManager
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ServiceCatalog::CloudFormationProvisionedProduct`.
Provisions the specified product.
A provisioned product is a resourced instance of a product. For example, provisioning a product based on a AWS CloudFormation template launches a AWS CloudFormation stack and its underlying resources. You can check the status of this request using [DescribeRecord](https://docs.aws.amazon.com/servicecatalog/latest/dg/API_DescribeRecord.html) .
If the request contains a tag key with an empty list of values, there is a tag conflict for that key. Do not include conflicted keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[ *N* ]: *Value* ".
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnCloudFormationProvisionedProduct := awscdk.Aws_servicecatalog.NewCfnCloudFormationProvisionedProduct(this, jsii.String("MyCfnCloudFormationProvisionedProduct"), &CfnCloudFormationProvisionedProductProps{
AcceptLanguage: jsii.String("acceptLanguage"),
NotificationArns: []*string{
jsii.String("notificationArns"),
},
PathId: jsii.String("pathId"),
PathName: jsii.String("pathName"),
ProductId: jsii.String("productId"),
ProductName: jsii.String("productName"),
ProvisionedProductName: jsii.String("provisionedProductName"),
ProvisioningArtifactId: jsii.String("provisioningArtifactId"),
ProvisioningArtifactName: jsii.String("provisioningArtifactName"),
ProvisioningParameters: []interface{}{
&ProvisioningParameterProperty{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
ProvisioningPreferences: &ProvisioningPreferencesProperty{
StackSetAccounts: []*string{
jsii.String("stackSetAccounts"),
},
StackSetFailureToleranceCount: jsii.Number(123),
StackSetFailureTolerancePercentage: jsii.Number(123),
StackSetMaxConcurrencyCount: jsii.Number(123),
StackSetMaxConcurrencyPercentage: jsii.Number(123),
StackSetOperationType: jsii.String("stackSetOperationType"),
StackSetRegions: []*string{
jsii.String("stackSetRegions"),
},
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnCloudFormationProvisionedProduct ¶
func NewCfnCloudFormationProvisionedProduct(scope constructs.Construct, id *string, props *CfnCloudFormationProvisionedProductProps) CfnCloudFormationProvisionedProduct
Create a new `AWS::ServiceCatalog::CloudFormationProvisionedProduct`.
type CfnCloudFormationProvisionedProductProps ¶
type CfnCloudFormationProvisionedProductProps struct {
// The language code.
//
// - `jp` - Japanese
// - `zh` - Chinese.
AcceptLanguage *string `field:"optional" json:"acceptLanguage" yaml:"acceptLanguage"`
// Passed to AWS CloudFormation .
//
// The SNS topic ARNs to which to publish stack-related events.
NotificationArns *[]*string `field:"optional" json:"notificationArns" yaml:"notificationArns"`
// The path identifier of the product.
//
// This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use [ListLaunchPaths](https://docs.aws.amazon.com/servicecatalog/latest/dg/API_ListLaunchPaths.html) .
//
// > You must provide the name or ID, but not both.
PathId *string `field:"optional" json:"pathId" yaml:"pathId"`
// The name of the path.
//
// This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use [ListLaunchPaths](https://docs.aws.amazon.com/servicecatalog/latest/dg/API_ListLaunchPaths.html) .
//
// > You must provide the name or ID, but not both.
PathName *string `field:"optional" json:"pathName" yaml:"pathName"`
// The product identifier.
//
// > You must specify either the ID or the name of the product, but not both.
ProductId *string `field:"optional" json:"productId" yaml:"productId"`
// The name of the Service Catalog product.
//
// Each time a stack is created or updated, if `ProductName` is provided it will successfully resolve to `ProductId` as long as only one product exists in the account or Region with that `ProductName` .
//
// > You must specify either the name or the ID of the product, but not both.
ProductName *string `field:"optional" json:"productName" yaml:"productName"`
// A user-friendly name for the provisioned product.
//
// This value must be unique for the AWS account and cannot be updated after the product is provisioned.
ProvisionedProductName *string `field:"optional" json:"provisionedProductName" yaml:"provisionedProductName"`
// The identifier of the provisioning artifact (also known as a version).
//
// > You must specify either the ID or the name of the provisioning artifact, but not both.
ProvisioningArtifactId *string `field:"optional" json:"provisioningArtifactId" yaml:"provisioningArtifactId"`
// The name of the provisioning artifact (also known as a version) for the product.
//
// This name must be unique for the product.
//
// > You must specify either the name or the ID of the provisioning artifact, but not both. You must also specify either the name or the ID of the product, but not both.
ProvisioningArtifactName *string `field:"optional" json:"provisioningArtifactName" yaml:"provisioningArtifactName"`
// Parameters specified by the administrator that are required for provisioning the product.
ProvisioningParameters interface{} `field:"optional" json:"provisioningParameters" yaml:"provisioningParameters"`
// StackSet preferences that are required for provisioning the product or updating a provisioned product.
ProvisioningPreferences interface{} `field:"optional" json:"provisioningPreferences" yaml:"provisioningPreferences"`
// One or more tags.
//
// > Requires the provisioned product to have an [ResourceUpdateConstraint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-resourceupdateconstraint.html) resource with `TagUpdatesOnProvisionedProduct` set to `ALLOWED` to allow tag updates. If `RESOURCE_UPDATE` constraint is not present, tags updates are ignored.
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnCloudFormationProvisionedProduct`.
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"
cfnCloudFormationProvisionedProductProps := &CfnCloudFormationProvisionedProductProps{
AcceptLanguage: jsii.String("acceptLanguage"),
NotificationArns: []*string{
jsii.String("notificationArns"),
},
PathId: jsii.String("pathId"),
PathName: jsii.String("pathName"),
ProductId: jsii.String("productId"),
ProductName: jsii.String("productName"),
ProvisionedProductName: jsii.String("provisionedProductName"),
ProvisioningArtifactId: jsii.String("provisioningArtifactId"),
ProvisioningArtifactName: jsii.String("provisioningArtifactName"),
ProvisioningParameters: []interface{}{
&ProvisioningParameterProperty{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
ProvisioningPreferences: &ProvisioningPreferencesProperty{
StackSetAccounts: []*string{
jsii.String("stackSetAccounts"),
},
StackSetFailureToleranceCount: jsii.Number(123),
StackSetFailureTolerancePercentage: jsii.Number(123),
StackSetMaxConcurrencyCount: jsii.Number(123),
StackSetMaxConcurrencyPercentage: jsii.Number(123),
StackSetOperationType: jsii.String("stackSetOperationType"),
StackSetRegions: []*string{
jsii.String("stackSetRegions"),
},
},
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnCloudFormationProvisionedProduct_ProvisioningParameterProperty ¶
type CfnCloudFormationProvisionedProduct_ProvisioningParameterProperty struct {
// The parameter key.
Key *string `field:"required" json:"key" yaml:"key"`
// The parameter value.
Value *string `field:"required" json:"value" yaml:"value"`
}
Information about a parameter used to provision a product.
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"
provisioningParameterProperty := &ProvisioningParameterProperty{
Key: jsii.String("key"),
Value: jsii.String("value"),
}
type CfnCloudFormationProvisionedProduct_ProvisioningPreferencesProperty ¶
type CfnCloudFormationProvisionedProduct_ProvisioningPreferencesProperty struct {
// One or more AWS accounts where the provisioned product will be available.
//
// Applicable only to a `CFN_STACKSET` provisioned product type.
//
// The specified accounts should be within the list of accounts from the `STACKSET` constraint. To get the list of accounts in the `STACKSET` constraint, use the `DescribeProvisioningParameters` operation.
//
// If no values are specified, the default value is all acounts from the `STACKSET` constraint.
StackSetAccounts *[]*string `field:"optional" json:"stackSetAccounts" yaml:"stackSetAccounts"`
// The number of accounts, per Region, for which this operation can fail before AWS Service Catalog stops the operation in that Region.
//
// If the operation is stopped in a Region, AWS Service Catalog doesn't attempt the operation in any subsequent Regions.
//
// Applicable only to a `CFN_STACKSET` provisioned product type.
//
// Conditional: You must specify either `StackSetFailureToleranceCount` or `StackSetFailureTolerancePercentage` , but not both.
//
// The default value is `0` if no value is specified.
StackSetFailureToleranceCount *float64 `field:"optional" json:"stackSetFailureToleranceCount" yaml:"stackSetFailureToleranceCount"`
// The percentage of accounts, per Region, for which this stack operation can fail before AWS Service Catalog stops the operation in that Region.
//
// If the operation is stopped in a Region, AWS Service Catalog doesn't attempt the operation in any subsequent Regions.
//
// When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number.
//
// Applicable only to a `CFN_STACKSET` provisioned product type.
//
// Conditional: You must specify either `StackSetFailureToleranceCount` or `StackSetFailureTolerancePercentage` , but not both.
StackSetFailureTolerancePercentage *float64 `field:"optional" json:"stackSetFailureTolerancePercentage" yaml:"stackSetFailureTolerancePercentage"`
// The maximum number of accounts in which to perform this operation at one time.
//
// This is dependent on the value of `StackSetFailureToleranceCount` . `StackSetMaxConcurrentCount` is at most one more than the `StackSetFailureToleranceCount` .
//
// 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.
//
// Applicable only to a `CFN_STACKSET` provisioned product type.
//
// Conditional: You must specify either `StackSetMaxConcurrentCount` or `StackSetMaxConcurrentPercentage` , but not both.
StackSetMaxConcurrencyCount *float64 `field:"optional" json:"stackSetMaxConcurrencyCount" yaml:"stackSetMaxConcurrencyCount"`
// 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, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as `1` 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.
//
// Applicable only to a `CFN_STACKSET` provisioned product type.
//
// Conditional: You must specify either `StackSetMaxConcurrentCount` or `StackSetMaxConcurrentPercentage` , but not both.
StackSetMaxConcurrencyPercentage *float64 `field:"optional" json:"stackSetMaxConcurrencyPercentage" yaml:"stackSetMaxConcurrencyPercentage"`
// Determines what action AWS Service Catalog performs to a stack set or a stack instance represented by the provisioned product.
//
// The default value is `UPDATE` if nothing is specified.
//
// Applicable only to a `CFN_STACKSET` provisioned product type.
//
// - **CREATE** - Creates a new stack instance in the stack set represented by the provisioned product. In this case, only new stack instances are created based on accounts and Regions; if new ProductId or ProvisioningArtifactID are passed, they will be ignored.
// - **UPDATE** - Updates the stack set represented by the provisioned product and also its stack instances.
// - **DELETE** - Deletes a stack instance in the stack set represented by the provisioned product.
StackSetOperationType *string `field:"optional" json:"stackSetOperationType" yaml:"stackSetOperationType"`
// One or more AWS Regions where the provisioned product will be available.
//
// Applicable only to a `CFN_STACKSET` provisioned product type.
//
// The specified Regions should be within the list of Regions from the `STACKSET` constraint. To get the list of Regions in the `STACKSET` constraint, use the `DescribeProvisioningParameters` operation.
//
// If no values are specified, the default value is all Regions from the `STACKSET` constraint.
StackSetRegions *[]*string `field:"optional" json:"stackSetRegions" yaml:"stackSetRegions"`
}
The user-defined preferences that will be applied when updating a provisioned product.
Not all preferences are applicable to all provisioned product type ¶
One or more AWS accounts that will have access to the provisioned product.
Applicable only to a `CFN_STACKSET` provisioned product type.
The AWS accounts specified should be within the list of accounts in the `STACKSET` constraint. To get the list of accounts in the `STACKSET` constraint, use the `DescribeProvisioningParameters` operation.
If no values are specified, the default value is all accounts from the `STACKSET` constraint.
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"
provisioningPreferencesProperty := &ProvisioningPreferencesProperty{
StackSetAccounts: []*string{
jsii.String("stackSetAccounts"),
},
StackSetFailureToleranceCount: jsii.Number(123),
StackSetFailureTolerancePercentage: jsii.Number(123),
StackSetMaxConcurrencyCount: jsii.Number(123),
StackSetMaxConcurrencyPercentage: jsii.Number(123),
StackSetOperationType: jsii.String("stackSetOperationType"),
StackSetRegions: []*string{
jsii.String("stackSetRegions"),
},
}
type CfnLaunchNotificationConstraint ¶
type CfnLaunchNotificationConstraint interface {
awscdk.CfnResource
awscdk.IInspectable
// The language code.
//
// - `jp` - Japanese
// - `zh` - Chinese.
AcceptLanguage() *string
SetAcceptLanguage(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
// The description of the constraint.
Description() *string
SetDescription(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// The notification ARNs.
NotificationArns() *[]*string
SetNotificationArns(val *[]*string)
// The portfolio identifier.
PortfolioId() *string
SetPortfolioId(val *string)
// The product identifier.
ProductId() *string
SetProductId(val *string)
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ServiceCatalog::LaunchNotificationConstraint`.
Specifies a notification constraint.
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"
cfnLaunchNotificationConstraint := awscdk.Aws_servicecatalog.NewCfnLaunchNotificationConstraint(this, jsii.String("MyCfnLaunchNotificationConstraint"), &CfnLaunchNotificationConstraintProps{
NotificationArns: []*string{
jsii.String("notificationArns"),
},
PortfolioId: jsii.String("portfolioId"),
ProductId: jsii.String("productId"),
// the properties below are optional
AcceptLanguage: jsii.String("acceptLanguage"),
Description: jsii.String("description"),
})
func NewCfnLaunchNotificationConstraint ¶
func NewCfnLaunchNotificationConstraint(scope constructs.Construct, id *string, props *CfnLaunchNotificationConstraintProps) CfnLaunchNotificationConstraint
Create a new `AWS::ServiceCatalog::LaunchNotificationConstraint`.
type CfnLaunchNotificationConstraintProps ¶
type CfnLaunchNotificationConstraintProps struct {
// The notification ARNs.
NotificationArns *[]*string `field:"required" json:"notificationArns" yaml:"notificationArns"`
// The portfolio identifier.
PortfolioId *string `field:"required" json:"portfolioId" yaml:"portfolioId"`
// The product identifier.
ProductId *string `field:"required" json:"productId" yaml:"productId"`
// The language code.
//
// - `jp` - Japanese
// - `zh` - Chinese.
AcceptLanguage *string `field:"optional" json:"acceptLanguage" yaml:"acceptLanguage"`
// The description of the constraint.
Description *string `field:"optional" json:"description" yaml:"description"`
}
Properties for defining a `CfnLaunchNotificationConstraint`.
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"
cfnLaunchNotificationConstraintProps := &CfnLaunchNotificationConstraintProps{
NotificationArns: []*string{
jsii.String("notificationArns"),
},
PortfolioId: jsii.String("portfolioId"),
ProductId: jsii.String("productId"),
// the properties below are optional
AcceptLanguage: jsii.String("acceptLanguage"),
Description: jsii.String("description"),
}
type CfnLaunchRoleConstraint ¶
type CfnLaunchRoleConstraint interface {
awscdk.CfnResource
awscdk.IInspectable
// The language code.
//
// - `jp` - Japanese
// - `zh` - Chinese.
AcceptLanguage() *string
SetAcceptLanguage(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
// The description of the constraint.
Description() *string
SetDescription(val *string)
// You are required to specify either the `RoleArn` or the `LocalRoleName` but can't use both.
//
// If you specify the `LocalRoleName` property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be account-agnostic so the administrator can create fewer resources per shared account.
//
// The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.
LocalRoleName() *string
SetLocalRoleName(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// The portfolio identifier.
PortfolioId() *string
SetPortfolioId(val *string)
// The product identifier.
ProductId() *string
SetProductId(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 ARN of the launch role.
//
// You are required to specify `RoleArn` or `LocalRoleName` but can't use both.
RoleArn() *string
SetRoleArn(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{})
}
A CloudFormation `AWS::ServiceCatalog::LaunchRoleConstraint`.
Specifies a launch constraint.
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"
cfnLaunchRoleConstraint := awscdk.Aws_servicecatalog.NewCfnLaunchRoleConstraint(this, jsii.String("MyCfnLaunchRoleConstraint"), &CfnLaunchRoleConstraintProps{
PortfolioId: jsii.String("portfolioId"),
ProductId: jsii.String("productId"),
// the properties below are optional
AcceptLanguage: jsii.String("acceptLanguage"),
Description: jsii.String("description"),
LocalRoleName: jsii.String("localRoleName"),
RoleArn: jsii.String("roleArn"),
})
func NewCfnLaunchRoleConstraint ¶
func NewCfnLaunchRoleConstraint(scope constructs.Construct, id *string, props *CfnLaunchRoleConstraintProps) CfnLaunchRoleConstraint
Create a new `AWS::ServiceCatalog::LaunchRoleConstraint`.
type CfnLaunchRoleConstraintProps ¶
type CfnLaunchRoleConstraintProps struct {
// The portfolio identifier.
PortfolioId *string `field:"required" json:"portfolioId" yaml:"portfolioId"`
// The product identifier.
ProductId *string `field:"required" json:"productId" yaml:"productId"`
// The language code.
//
// - `jp` - Japanese
// - `zh` - Chinese.
AcceptLanguage *string `field:"optional" json:"acceptLanguage" yaml:"acceptLanguage"`
// The description of the constraint.
Description *string `field:"optional" json:"description" yaml:"description"`
// You are required to specify either the `RoleArn` or the `LocalRoleName` but can't use both.
//
// If you specify the `LocalRoleName` property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be account-agnostic so the administrator can create fewer resources per shared account.
//
// The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.
LocalRoleName *string `field:"optional" json:"localRoleName" yaml:"localRoleName"`
// The ARN of the launch role.
//
// You are required to specify `RoleArn` or `LocalRoleName` but can't use both.
RoleArn *string `field:"optional" json:"roleArn" yaml:"roleArn"`
}
Properties for defining a `CfnLaunchRoleConstraint`.
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"
cfnLaunchRoleConstraintProps := &CfnLaunchRoleConstraintProps{
PortfolioId: jsii.String("portfolioId"),
ProductId: jsii.String("productId"),
// the properties below are optional
AcceptLanguage: jsii.String("acceptLanguage"),
Description: jsii.String("description"),
LocalRoleName: jsii.String("localRoleName"),
RoleArn: jsii.String("roleArn"),
}
type CfnLaunchTemplateConstraint ¶
type CfnLaunchTemplateConstraint interface {
awscdk.CfnResource
awscdk.IInspectable
// The language code.
//
// - `jp` - Japanese
// - `zh` - Chinese.
AcceptLanguage() *string
SetAcceptLanguage(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
// The description of the constraint.
Description() *string
SetDescription(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// The portfolio identifier.
PortfolioId() *string
SetPortfolioId(val *string)
// The product identifier.
ProductId() *string
SetProductId(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 constraint rules.
Rules() *string
SetRules(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{})
}
A CloudFormation `AWS::ServiceCatalog::LaunchTemplateConstraint`.
Specifies a template constraint.
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"
cfnLaunchTemplateConstraint := awscdk.Aws_servicecatalog.NewCfnLaunchTemplateConstraint(this, jsii.String("MyCfnLaunchTemplateConstraint"), &CfnLaunchTemplateConstraintProps{
PortfolioId: jsii.String("portfolioId"),
ProductId: jsii.String("productId"),
Rules: jsii.String("rules"),
// the properties below are optional
AcceptLanguage: jsii.String("acceptLanguage"),
Description: jsii.String("description"),
})
func NewCfnLaunchTemplateConstraint ¶
func NewCfnLaunchTemplateConstraint(scope constructs.Construct, id *string, props *CfnLaunchTemplateConstraintProps) CfnLaunchTemplateConstraint
Create a new `AWS::ServiceCatalog::LaunchTemplateConstraint`.
type CfnLaunchTemplateConstraintProps ¶
type CfnLaunchTemplateConstraintProps struct {
// The portfolio identifier.
PortfolioId *string `field:"required" json:"portfolioId" yaml:"portfolioId"`
// The product identifier.
ProductId *string `field:"required" json:"productId" yaml:"productId"`
// The constraint rules.
Rules *string `field:"required" json:"rules" yaml:"rules"`
// The language code.
//
// - `jp` - Japanese
// - `zh` - Chinese.
AcceptLanguage *string `field:"optional" json:"acceptLanguage" yaml:"acceptLanguage"`
// The description of the constraint.
Description *string `field:"optional" json:"description" yaml:"description"`
}
Properties for defining a `CfnLaunchTemplateConstraint`.
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"
cfnLaunchTemplateConstraintProps := &CfnLaunchTemplateConstraintProps{
PortfolioId: jsii.String("portfolioId"),
ProductId: jsii.String("productId"),
Rules: jsii.String("rules"),
// the properties below are optional
AcceptLanguage: jsii.String("acceptLanguage"),
Description: jsii.String("description"),
}
type CfnPortfolio ¶
type CfnPortfolio interface {
awscdk.CfnResource
awscdk.IInspectable
// The language code.
//
// - `jp` - Japanese
// - `zh` - Chinese.
AcceptLanguage() *string
SetAcceptLanguage(val *string)
// The name of the portfolio.
AttrPortfolioName() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The description of the portfolio.
Description() *string
SetDescription(val *string)
// The name to use for display purposes.
DisplayName() *string
SetDisplayName(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// The name of the portfolio provider.
ProviderName() *string
SetProviderName(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
// One or more tags.
Tags() awscdk.TagManager
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ServiceCatalog::Portfolio`.
Specifies a portfolio.
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"
cfnPortfolio := awscdk.Aws_servicecatalog.NewCfnPortfolio(this, jsii.String("MyCfnPortfolio"), &CfnPortfolioProps{
DisplayName: jsii.String("displayName"),
ProviderName: jsii.String("providerName"),
// the properties below are optional
AcceptLanguage: jsii.String("acceptLanguage"),
Description: jsii.String("description"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnPortfolio ¶
func NewCfnPortfolio(scope constructs.Construct, id *string, props *CfnPortfolioProps) CfnPortfolio
Create a new `AWS::ServiceCatalog::Portfolio`.
type CfnPortfolioPrincipalAssociation ¶
type CfnPortfolioPrincipalAssociation interface {
awscdk.CfnResource
awscdk.IInspectable
// The language code.
//
// - `jp` - Japanese
// - `zh` - Chinese.
AcceptLanguage() *string
SetAcceptLanguage(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
// 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 portfolio identifier.
PortfolioId() *string
SetPortfolioId(val *string)
// The ARN of the principal ( IAM user, role, or group).
PrincipalArn() *string
SetPrincipalArn(val *string)
// The principal type. The supported value is `IAM` .
//
// *Allowed Values* : `IAM`.
PrincipalType() *string
SetPrincipalType(val *string)
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ServiceCatalog::PortfolioPrincipalAssociation`.
Associates the specified principal ARN with the specified portfolio.
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"
cfnPortfolioPrincipalAssociation := awscdk.Aws_servicecatalog.NewCfnPortfolioPrincipalAssociation(this, jsii.String("MyCfnPortfolioPrincipalAssociation"), &CfnPortfolioPrincipalAssociationProps{
PortfolioId: jsii.String("portfolioId"),
PrincipalArn: jsii.String("principalArn"),
PrincipalType: jsii.String("principalType"),
// the properties below are optional
AcceptLanguage: jsii.String("acceptLanguage"),
})
func NewCfnPortfolioPrincipalAssociation ¶
func NewCfnPortfolioPrincipalAssociation(scope constructs.Construct, id *string, props *CfnPortfolioPrincipalAssociationProps) CfnPortfolioPrincipalAssociation
Create a new `AWS::ServiceCatalog::PortfolioPrincipalAssociation`.
type CfnPortfolioPrincipalAssociationProps ¶
type CfnPortfolioPrincipalAssociationProps struct {
// The portfolio identifier.
PortfolioId *string `field:"required" json:"portfolioId" yaml:"portfolioId"`
// The ARN of the principal ( IAM user, role, or group).
PrincipalArn *string `field:"required" json:"principalArn" yaml:"principalArn"`
// The principal type. The supported value is `IAM` .
//
// *Allowed Values* : `IAM`.
PrincipalType *string `field:"required" json:"principalType" yaml:"principalType"`
// The language code.
//
// - `jp` - Japanese
// - `zh` - Chinese.
AcceptLanguage *string `field:"optional" json:"acceptLanguage" yaml:"acceptLanguage"`
}
Properties for defining a `CfnPortfolioPrincipalAssociation`.
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"
cfnPortfolioPrincipalAssociationProps := &CfnPortfolioPrincipalAssociationProps{
PortfolioId: jsii.String("portfolioId"),
PrincipalArn: jsii.String("principalArn"),
PrincipalType: jsii.String("principalType"),
// the properties below are optional
AcceptLanguage: jsii.String("acceptLanguage"),
}
type CfnPortfolioProductAssociation ¶
type CfnPortfolioProductAssociation interface {
awscdk.CfnResource
awscdk.IInspectable
// The language code.
//
// - `jp` - Japanese
// - `zh` - Chinese.
AcceptLanguage() *string
SetAcceptLanguage(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
// 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 portfolio identifier.
PortfolioId() *string
SetPortfolioId(val *string)
// The product identifier.
ProductId() *string
SetProductId(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 identifier of the source portfolio.
SourcePortfolioId() *string
SetSourcePortfolioId(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{})
}
A CloudFormation `AWS::ServiceCatalog::PortfolioProductAssociation`.
Associates the specified product with the specified portfolio.
A delegated admin is authorized to invoke this command.
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"
cfnPortfolioProductAssociation := awscdk.Aws_servicecatalog.NewCfnPortfolioProductAssociation(this, jsii.String("MyCfnPortfolioProductAssociation"), &CfnPortfolioProductAssociationProps{
PortfolioId: jsii.String("portfolioId"),
ProductId: jsii.String("productId"),
// the properties below are optional
AcceptLanguage: jsii.String("acceptLanguage"),
SourcePortfolioId: jsii.String("sourcePortfolioId"),
})
func NewCfnPortfolioProductAssociation ¶
func NewCfnPortfolioProductAssociation(scope constructs.Construct, id *string, props *CfnPortfolioProductAssociationProps) CfnPortfolioProductAssociation
Create a new `AWS::ServiceCatalog::PortfolioProductAssociation`.
type CfnPortfolioProductAssociationProps ¶
type CfnPortfolioProductAssociationProps struct {
// The portfolio identifier.
PortfolioId *string `field:"required" json:"portfolioId" yaml:"portfolioId"`
// The product identifier.
ProductId *string `field:"required" json:"productId" yaml:"productId"`
// The language code.
//
// - `jp` - Japanese
// - `zh` - Chinese.
AcceptLanguage *string `field:"optional" json:"acceptLanguage" yaml:"acceptLanguage"`
// The identifier of the source portfolio.
SourcePortfolioId *string `field:"optional" json:"sourcePortfolioId" yaml:"sourcePortfolioId"`
}
Properties for defining a `CfnPortfolioProductAssociation`.
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"
cfnPortfolioProductAssociationProps := &CfnPortfolioProductAssociationProps{
PortfolioId: jsii.String("portfolioId"),
ProductId: jsii.String("productId"),
// the properties below are optional
AcceptLanguage: jsii.String("acceptLanguage"),
SourcePortfolioId: jsii.String("sourcePortfolioId"),
}
type CfnPortfolioProps ¶
type CfnPortfolioProps struct {
// The name to use for display purposes.
DisplayName *string `field:"required" json:"displayName" yaml:"displayName"`
// The name of the portfolio provider.
ProviderName *string `field:"required" json:"providerName" yaml:"providerName"`
// The language code.
//
// - `jp` - Japanese
// - `zh` - Chinese.
AcceptLanguage *string `field:"optional" json:"acceptLanguage" yaml:"acceptLanguage"`
// The description of the portfolio.
Description *string `field:"optional" json:"description" yaml:"description"`
// One or more tags.
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnPortfolio`.
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"
cfnPortfolioProps := &CfnPortfolioProps{
DisplayName: jsii.String("displayName"),
ProviderName: jsii.String("providerName"),
// the properties below are optional
AcceptLanguage: jsii.String("acceptLanguage"),
Description: jsii.String("description"),
Tags: []cfnTag{
&cfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnPortfolioShare ¶
type CfnPortfolioShare interface {
awscdk.CfnResource
awscdk.IInspectable
// The language code.
//
// - `jp` - Japanese
// - `zh` - Chinese.
// The AWS account ID.
//
// For example, `123456789012` .
// Options for this resource, such as condition, update policy etc.
CfnResourceType() *string
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
//
// 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
Node() constructs.Node
// The portfolio identifier.
//
// 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
// Indicates whether TagOptions sharing is enabled or disabled for the portfolio share.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// 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{}
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
AddDeletionOverride(path *string)
//
// 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)
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// 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{})
//
// 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{})
AddPropertyDeletionOverride(propertyPath *string)
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
//
// 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)
//
// 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
// 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{}
Inspect(inspector awscdk.TreeInspector)
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
ObtainResourceDependencies() *[]awscdk.CfnResource
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.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
//
// 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.
}
A CloudFormation `AWS::ServiceCatalog::PortfolioShare`.
Shares the specified portfolio with the specified account.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnPortfolioShare := awscdk.Aws_servicecatalog.NewCfnPortfolioShare(this, jsii.String("MyCfnPortfolioShare"), &CfnPortfolioShareProps{
AccountId: jsii.String("accountId"),
PortfolioId: jsii.String("portfolioId"),
// the properties below are optional
AcceptLanguage: jsii.String("acceptLanguage"),
ShareTagOptions: jsii.Boolean(false),
})
func NewCfnPortfolioShare ¶
func NewCfnPortfolioShare(scope constructs.Construct, id *string, props *CfnPortfolioShareProps) CfnPortfolioShare
Create a new `AWS::ServiceCatalog::PortfolioShare`.
type CfnPortfolioShareProps ¶
type CfnPortfolioShareProps struct {
//
// For example, `123456789012` .
AccountId *string `field:"required" json:"accountId" yaml:"accountId"`
PortfolioId *string `field:"required" json:"portfolioId" yaml:"portfolioId"`
//
// - `jp` - Japanese
// - `zh` - Chinese.
AcceptLanguage *string `field:"optional" json:"acceptLanguage" yaml:"acceptLanguage"`
ShareTagOptions interface{} `field:"optional" json:"shareTagOptions" yaml:"shareTagOptions"`
}
Properties for defining a `CfnPortfolioShare`.
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"
cfnPortfolioShareProps := &CfnPortfolioShareProps{
AccountId: jsii.String("accountId"),
PortfolioId: jsii.String("portfolioId"),
// the properties below are optional
AcceptLanguage: jsii.String("acceptLanguage"),
ShareTagOptions: jsii.Boolean(false),
}
type CfnResourceUpdateConstraint ¶
type CfnResourceUpdateConstraint interface {
awscdk.CfnResource
awscdk.IInspectable
// The language code.
//
// - `jp` - Japanese
// - `zh` - Chinese.
AcceptLanguage() *string
SetAcceptLanguage(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
// The description of the constraint.
Description() *string
SetDescription(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// The portfolio identifier.
PortfolioId() *string
SetPortfolioId(val *string)
// The product identifier.
ProductId() *string
SetProductId(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
// If set to `ALLOWED` , lets users change tags in a [CloudFormationProvisionedProduct](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html) resource.
//
// If set to `NOT_ALLOWED` , prevents users from changing tags in a [CloudFormationProvisionedProduct](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html) resource.
TagUpdateOnProvisionedProduct() *string
SetTagUpdateOnProvisionedProduct(val *string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ServiceCatalog::ResourceUpdateConstraint`.
Specifies a `RESOURCE_UPDATE` constraint.
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"
cfnResourceUpdateConstraint := awscdk.Aws_servicecatalog.NewCfnResourceUpdateConstraint(this, jsii.String("MyCfnResourceUpdateConstraint"), &CfnResourceUpdateConstraintProps{
PortfolioId: jsii.String("portfolioId"),
ProductId: jsii.String("productId"),
TagUpdateOnProvisionedProduct: jsii.String("tagUpdateOnProvisionedProduct"),
// the properties below are optional
AcceptLanguage: jsii.String("acceptLanguage"),
Description: jsii.String("description"),
})
func NewCfnResourceUpdateConstraint ¶
func NewCfnResourceUpdateConstraint(scope constructs.Construct, id *string, props *CfnResourceUpdateConstraintProps) CfnResourceUpdateConstraint
Create a new `AWS::ServiceCatalog::ResourceUpdateConstraint`.
type CfnResourceUpdateConstraintProps ¶
type CfnResourceUpdateConstraintProps struct {
// The portfolio identifier.
PortfolioId *string `field:"required" json:"portfolioId" yaml:"portfolioId"`
// The product identifier.
ProductId *string `field:"required" json:"productId" yaml:"productId"`
// If set to `ALLOWED` , lets users change tags in a [CloudFormationProvisionedProduct](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html) resource.
//
// If set to `NOT_ALLOWED` , prevents users from changing tags in a [CloudFormationProvisionedProduct](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html) resource.
TagUpdateOnProvisionedProduct *string `field:"required" json:"tagUpdateOnProvisionedProduct" yaml:"tagUpdateOnProvisionedProduct"`
// The language code.
//
// - `jp` - Japanese
// - `zh` - Chinese.
AcceptLanguage *string `field:"optional" json:"acceptLanguage" yaml:"acceptLanguage"`
// The description of the constraint.
Description *string `field:"optional" json:"description" yaml:"description"`
}
Properties for defining a `CfnResourceUpdateConstraint`.
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"
cfnResourceUpdateConstraintProps := &CfnResourceUpdateConstraintProps{
PortfolioId: jsii.String("portfolioId"),
ProductId: jsii.String("productId"),
TagUpdateOnProvisionedProduct: jsii.String("tagUpdateOnProvisionedProduct"),
// the properties below are optional
AcceptLanguage: jsii.String("acceptLanguage"),
Description: jsii.String("description"),
}
type CfnServiceAction ¶
type CfnServiceAction interface {
awscdk.CfnResource
awscdk.IInspectable
// The language code.
//
// - `en` - English (default)
// - `jp` - Japanese
// - `zh` - Chinese.
AcceptLanguage() *string
SetAcceptLanguage(val *string)
// The self-service action identifier.
//
// For example, `act-fs7abcd89wxyz` .
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 map that defines the self-service action.
Definition() interface{}
SetDefinition(val interface{})
// The self-service action definition type.
//
// For example, `SSM_AUTOMATION` .
DefinitionType() *string
SetDefinitionType(val *string)
// The self-service action description.
Description() *string
SetDescription(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The self-service action name.
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{})
}
A CloudFormation `AWS::ServiceCatalog::ServiceAction`.
Creates a self-service action.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnServiceAction := awscdk.Aws_servicecatalog.NewCfnServiceAction(this, jsii.String("MyCfnServiceAction"), &CfnServiceActionProps{
Definition: []interface{}{
&DefinitionParameterProperty{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
DefinitionType: jsii.String("definitionType"),
Name: jsii.String("name"),
// the properties below are optional
AcceptLanguage: jsii.String("acceptLanguage"),
Description: jsii.String("description"),
})
func NewCfnServiceAction ¶
func NewCfnServiceAction(scope constructs.Construct, id *string, props *CfnServiceActionProps) CfnServiceAction
Create a new `AWS::ServiceCatalog::ServiceAction`.
type CfnServiceActionAssociation ¶
type CfnServiceActionAssociation interface {
awscdk.CfnResource
awscdk.IInspectable
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// 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 product identifier.
//
// For example, `prod-abcdzk7xy33qa` .
ProductId() *string
SetProductId(val *string)
// The identifier of the provisioning artifact.
//
// For example, `pa-4abcdjnxjj6ne` .
ProvisioningArtifactId() *string
SetProvisioningArtifactId(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 self-service action identifier.
//
// For example, `act-fs7abcd89wxyz` .
ServiceActionId() *string
SetServiceActionId(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{})
}
A CloudFormation `AWS::ServiceCatalog::ServiceActionAssociation`.
A self-service action association consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnServiceActionAssociation := awscdk.Aws_servicecatalog.NewCfnServiceActionAssociation(this, jsii.String("MyCfnServiceActionAssociation"), &CfnServiceActionAssociationProps{
ProductId: jsii.String("productId"),
ProvisioningArtifactId: jsii.String("provisioningArtifactId"),
ServiceActionId: jsii.String("serviceActionId"),
})
func NewCfnServiceActionAssociation ¶
func NewCfnServiceActionAssociation(scope constructs.Construct, id *string, props *CfnServiceActionAssociationProps) CfnServiceActionAssociation
Create a new `AWS::ServiceCatalog::ServiceActionAssociation`.
type CfnServiceActionAssociationProps ¶
type CfnServiceActionAssociationProps struct {
// The product identifier.
//
// For example, `prod-abcdzk7xy33qa` .
ProductId *string `field:"required" json:"productId" yaml:"productId"`
// The identifier of the provisioning artifact.
//
// For example, `pa-4abcdjnxjj6ne` .
ProvisioningArtifactId *string `field:"required" json:"provisioningArtifactId" yaml:"provisioningArtifactId"`
// The self-service action identifier.
//
// For example, `act-fs7abcd89wxyz` .
ServiceActionId *string `field:"required" json:"serviceActionId" yaml:"serviceActionId"`
}
Properties for defining a `CfnServiceActionAssociation`.
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"
cfnServiceActionAssociationProps := &CfnServiceActionAssociationProps{
ProductId: jsii.String("productId"),
ProvisioningArtifactId: jsii.String("provisioningArtifactId"),
ServiceActionId: jsii.String("serviceActionId"),
}
type CfnServiceActionProps ¶
type CfnServiceActionProps struct {
// A map that defines the self-service action.
Definition interface{} `field:"required" json:"definition" yaml:"definition"`
// The self-service action definition type.
//
// For example, `SSM_AUTOMATION` .
DefinitionType *string `field:"required" json:"definitionType" yaml:"definitionType"`
// The self-service action name.
Name *string `field:"required" json:"name" yaml:"name"`
// The language code.
//
// - `en` - English (default)
// - `jp` - Japanese
// - `zh` - Chinese.
AcceptLanguage *string `field:"optional" json:"acceptLanguage" yaml:"acceptLanguage"`
// The self-service action description.
Description *string `field:"optional" json:"description" yaml:"description"`
}
Properties for defining a `CfnServiceAction`.
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"
cfnServiceActionProps := &CfnServiceActionProps{
Definition: []interface{}{
&DefinitionParameterProperty{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
DefinitionType: jsii.String("definitionType"),
Name: jsii.String("name"),
// the properties below are optional
AcceptLanguage: jsii.String("acceptLanguage"),
Description: jsii.String("description"),
}
type CfnServiceAction_DefinitionParameterProperty ¶
type CfnServiceAction_DefinitionParameterProperty struct {
// The parameter key.
Key *string `field:"required" json:"key" yaml:"key"`
// The value of the parameter.
Value *string `field:"required" json:"value" yaml:"value"`
}
The list of parameters in JSON format.
For example: `[{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}] or [{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}]` .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
definitionParameterProperty := &DefinitionParameterProperty{
Key: jsii.String("key"),
Value: jsii.String("value"),
}
type CfnStackSetConstraint ¶
type CfnStackSetConstraint interface {
awscdk.CfnResource
awscdk.IInspectable
// The language code.
//
// - `jp` - Japanese
// - `zh` - Chinese.
AcceptLanguage() *string
SetAcceptLanguage(val *string)
// One or more AWS accounts that will have access to the provisioned product.
AccountList() *[]*string
SetAccountList(val *[]*string)
// AdminRole ARN.
AdminRole() *string
SetAdminRole(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
// The description of the constraint.
Description() *string
SetDescription(val *string)
// ExecutionRole name.
ExecutionRole() *string
SetExecutionRole(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// The portfolio identifier.
PortfolioId() *string
SetPortfolioId(val *string)
// The product identifier.
ProductId() *string
SetProductId(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
// One or more AWS Regions where the provisioned product will be available.
//
// Applicable only to a `CFN_STACKSET` provisioned product type.
//
// The specified Regions should be within the list of Regions from the `STACKSET` constraint. To get the list of Regions in the `STACKSET` constraint, use the `DescribeProvisioningParameters` operation.
//
// If no values are specified, the default value is all Regions from the `STACKSET` constraint.
RegionList() *[]*string
SetRegionList(val *[]*string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Permission to create, update, and delete stack instances.
//
// Choose from ALLOWED and NOT_ALLOWED.
StackInstanceControl() *string
SetStackInstanceControl(val *string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ServiceCatalog::StackSetConstraint`.
Specifies a StackSet constraint.
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"
cfnStackSetConstraint := awscdk.Aws_servicecatalog.NewCfnStackSetConstraint(this, jsii.String("MyCfnStackSetConstraint"), &CfnStackSetConstraintProps{
AccountList: []*string{
jsii.String("accountList"),
},
AdminRole: jsii.String("adminRole"),
Description: jsii.String("description"),
ExecutionRole: jsii.String("executionRole"),
PortfolioId: jsii.String("portfolioId"),
ProductId: jsii.String("productId"),
RegionList: []*string{
jsii.String("regionList"),
},
StackInstanceControl: jsii.String("stackInstanceControl"),
// the properties below are optional
AcceptLanguage: jsii.String("acceptLanguage"),
})
func NewCfnStackSetConstraint ¶
func NewCfnStackSetConstraint(scope constructs.Construct, id *string, props *CfnStackSetConstraintProps) CfnStackSetConstraint
Create a new `AWS::ServiceCatalog::StackSetConstraint`.
type CfnStackSetConstraintProps ¶
type CfnStackSetConstraintProps struct {
// One or more AWS accounts that will have access to the provisioned product.
AccountList *[]*string `field:"required" json:"accountList" yaml:"accountList"`
// AdminRole ARN.
AdminRole *string `field:"required" json:"adminRole" yaml:"adminRole"`
// The description of the constraint.
Description *string `field:"required" json:"description" yaml:"description"`
// ExecutionRole name.
ExecutionRole *string `field:"required" json:"executionRole" yaml:"executionRole"`
// The portfolio identifier.
PortfolioId *string `field:"required" json:"portfolioId" yaml:"portfolioId"`
// The product identifier.
ProductId *string `field:"required" json:"productId" yaml:"productId"`
// One or more AWS Regions where the provisioned product will be available.
//
// Applicable only to a `CFN_STACKSET` provisioned product type.
//
// The specified Regions should be within the list of Regions from the `STACKSET` constraint. To get the list of Regions in the `STACKSET` constraint, use the `DescribeProvisioningParameters` operation.
//
// If no values are specified, the default value is all Regions from the `STACKSET` constraint.
RegionList *[]*string `field:"required" json:"regionList" yaml:"regionList"`
// Permission to create, update, and delete stack instances.
//
// Choose from ALLOWED and NOT_ALLOWED.
StackInstanceControl *string `field:"required" json:"stackInstanceControl" yaml:"stackInstanceControl"`
// The language code.
//
// - `jp` - Japanese
// - `zh` - Chinese.
AcceptLanguage *string `field:"optional" json:"acceptLanguage" yaml:"acceptLanguage"`
}
Properties for defining a `CfnStackSetConstraint`.
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"
cfnStackSetConstraintProps := &CfnStackSetConstraintProps{
AccountList: []*string{
jsii.String("accountList"),
},
AdminRole: jsii.String("adminRole"),
Description: jsii.String("description"),
ExecutionRole: jsii.String("executionRole"),
PortfolioId: jsii.String("portfolioId"),
ProductId: jsii.String("productId"),
RegionList: []*string{
jsii.String("regionList"),
},
StackInstanceControl: jsii.String("stackInstanceControl"),
// the properties below are optional
AcceptLanguage: jsii.String("acceptLanguage"),
}
type CfnTagOption ¶
type CfnTagOption interface {
awscdk.CfnResource
awscdk.IInspectable
// The TagOption active state.
Active() interface{}
SetActive(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
// The TagOption key.
Key() *string
SetKey(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// The TagOption value.
Value() *string
SetValue(val *string)
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ServiceCatalog::TagOption`.
Specifies a TagOption. A TagOption is a key-value pair managed by AWS Service Catalog that serves as a template for creating an AWS tag.
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"
cfnTagOption := awscdk.Aws_servicecatalog.NewCfnTagOption(this, jsii.String("MyCfnTagOption"), &CfnTagOptionProps{
Key: jsii.String("key"),
Value: jsii.String("value"),
// the properties below are optional
Active: jsii.Boolean(false),
})
func NewCfnTagOption ¶
func NewCfnTagOption(scope constructs.Construct, id *string, props *CfnTagOptionProps) CfnTagOption
Create a new `AWS::ServiceCatalog::TagOption`.
type CfnTagOptionAssociation ¶
type CfnTagOptionAssociation interface {
awscdk.CfnResource
awscdk.IInspectable
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// 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 resource identifier.
ResourceId() *string
SetResourceId(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 TagOption identifier.
TagOptionId() *string
SetTagOptionId(val *string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ServiceCatalog::TagOptionAssociation`.
Associate the specified TagOption with the specified portfolio or product.
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"
cfnTagOptionAssociation := awscdk.Aws_servicecatalog.NewCfnTagOptionAssociation(this, jsii.String("MyCfnTagOptionAssociation"), &CfnTagOptionAssociationProps{
ResourceId: jsii.String("resourceId"),
TagOptionId: jsii.String("tagOptionId"),
})
func NewCfnTagOptionAssociation ¶
func NewCfnTagOptionAssociation(scope constructs.Construct, id *string, props *CfnTagOptionAssociationProps) CfnTagOptionAssociation
Create a new `AWS::ServiceCatalog::TagOptionAssociation`.
type CfnTagOptionAssociationProps ¶
type CfnTagOptionAssociationProps struct {
// The resource identifier.
ResourceId *string `field:"required" json:"resourceId" yaml:"resourceId"`
// The TagOption identifier.
TagOptionId *string `field:"required" json:"tagOptionId" yaml:"tagOptionId"`
}
Properties for defining a `CfnTagOptionAssociation`.
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"
cfnTagOptionAssociationProps := &CfnTagOptionAssociationProps{
ResourceId: jsii.String("resourceId"),
TagOptionId: jsii.String("tagOptionId"),
}
type CfnTagOptionProps ¶
type CfnTagOptionProps struct {
// The TagOption key.
Key *string `field:"required" json:"key" yaml:"key"`
// The TagOption value.
Value *string `field:"required" json:"value" yaml:"value"`
// The TagOption active state.
Active interface{} `field:"optional" json:"active" yaml:"active"`
}
Properties for defining a `CfnTagOption`.
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"
cfnTagOptionProps := &CfnTagOptionProps{
Key: jsii.String("key"),
Value: jsii.String("value"),
// the properties below are optional
Active: jsii.Boolean(false),
}
type CloudFormationProduct ¶ added in v2.23.0
type CloudFormationProduct interface {
Product
// The asset bucket of a product created via product stack.
AssetBuckets() *[]awss3.IBucket
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// The tree node.
Node() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// The ARN of the product.
ProductArn() *string
// The id of the product.
ProductId() *string
// The stack in which this resource is defined.
Stack() awscdk.Stack
// Apply the given removal policy to this resource.
//
// 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`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
// Associate Tag Options.
//
// A TagOption is a key-value pair managed in AWS Service Catalog.
// It is not an AWS tag, but serves as a template for creating an AWS tag based on the TagOption.
AssociateTagOptions(tagOptions TagOptions)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Returns a string representation of this construct.
ToString() *string
}
A Service Catalog Cloudformation Product.
Example:
import s3 "github.com/aws/aws-cdk-go/awscdk"
import cdk "github.com/aws/aws-cdk-go/awscdk"
type s3BucketProduct struct {
productStack
}
func newS3BucketProduct(scope construct, id *string) *s3BucketProduct {
this := &s3BucketProduct{}
servicecatalog.NewProductStack_Override(this, scope, id)
s3.NewBucket(this, jsii.String("BucketProduct"))
return this
}
product := servicecatalog.NewCloudFormationProduct(this, jsii.String("Product"), &CloudFormationProductProps{
ProductName: jsii.String("My Product"),
Owner: jsii.String("Product Owner"),
ProductVersions: []cloudFormationProductVersion{
&cloudFormationProductVersion{
ProductVersionName: jsii.String("v1"),
CloudFormationTemplate: servicecatalog.CloudFormationTemplate_FromProductStack(NewS3BucketProduct(this, jsii.String("S3BucketProduct"))),
},
},
})
func NewCloudFormationProduct ¶ added in v2.23.0
func NewCloudFormationProduct(scope constructs.Construct, id *string, props *CloudFormationProductProps) CloudFormationProduct
type CloudFormationProductProps ¶ added in v2.23.0
type CloudFormationProductProps struct {
// The owner of the product.
Owner *string `field:"required" json:"owner" yaml:"owner"`
// The name of the product.
ProductName *string `field:"required" json:"productName" yaml:"productName"`
// The configuration of the product version.
ProductVersions *[]*CloudFormationProductVersion `field:"required" json:"productVersions" yaml:"productVersions"`
// The description of the product.
Description *string `field:"optional" json:"description" yaml:"description"`
// The distributor of the product.
Distributor *string `field:"optional" json:"distributor" yaml:"distributor"`
// The language code.
//
// Controls language for logging and errors.
MessageLanguage MessageLanguage `field:"optional" json:"messageLanguage" yaml:"messageLanguage"`
// Whether to give provisioning artifacts a new unique identifier when the product attributes or provisioning artifacts is updated.
ReplaceProductVersionIds *bool `field:"optional" json:"replaceProductVersionIds" yaml:"replaceProductVersionIds"`
// The support information about the product.
SupportDescription *string `field:"optional" json:"supportDescription" yaml:"supportDescription"`
// The contact email for product support.
SupportEmail *string `field:"optional" json:"supportEmail" yaml:"supportEmail"`
// The contact URL for product support.
SupportUrl *string `field:"optional" json:"supportUrl" yaml:"supportUrl"`
// TagOptions associated directly to a product.
TagOptions TagOptions `field:"optional" json:"tagOptions" yaml:"tagOptions"`
}
Properties for a Cloudformation Product.
Example:
import s3 "github.com/aws/aws-cdk-go/awscdk"
import cdk "github.com/aws/aws-cdk-go/awscdk"
type s3BucketProduct struct {
productStack
}
func newS3BucketProduct(scope construct, id *string) *s3BucketProduct {
this := &s3BucketProduct{}
servicecatalog.NewProductStack_Override(this, scope, id)
s3.NewBucket(this, jsii.String("BucketProduct"))
return this
}
product := servicecatalog.NewCloudFormationProduct(this, jsii.String("Product"), &CloudFormationProductProps{
ProductName: jsii.String("My Product"),
Owner: jsii.String("Product Owner"),
ProductVersions: []cloudFormationProductVersion{
&cloudFormationProductVersion{
ProductVersionName: jsii.String("v1"),
CloudFormationTemplate: servicecatalog.CloudFormationTemplate_FromProductStack(NewS3BucketProduct(this, jsii.String("S3BucketProduct"))),
},
},
})
type CloudFormationProductVersion ¶ added in v2.23.0
type CloudFormationProductVersion struct {
// The S3 template that points to the provisioning version template.
CloudFormationTemplate CloudFormationTemplate `field:"required" json:"cloudFormationTemplate" yaml:"cloudFormationTemplate"`
// The description of the product version.
Description *string `field:"optional" json:"description" yaml:"description"`
// The name of the product version.
ProductVersionName *string `field:"optional" json:"productVersionName" yaml:"productVersionName"`
// Whether the specified product template will be validated by CloudFormation.
//
// If turned off, an invalid template configuration can be stored.
ValidateTemplate *bool `field:"optional" json:"validateTemplate" yaml:"validateTemplate"`
}
Properties of product version (also known as a provisioning artifact).
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 cloudFormationTemplate cloudFormationTemplate
cloudFormationProductVersion := &CloudFormationProductVersion{
CloudFormationTemplate: cloudFormationTemplate,
// the properties below are optional
Description: jsii.String("description"),
ProductVersionName: jsii.String("productVersionName"),
ValidateTemplate: jsii.Boolean(false),
}
type CloudFormationRuleConstraintOptions ¶ added in v2.23.0
type CloudFormationRuleConstraintOptions struct {
// The description of the constraint.
Description *string `field:"optional" json:"description" yaml:"description"`
// The language code.
//
// Configures the language for error messages from service catalog.
MessageLanguage MessageLanguage `field:"optional" json:"messageLanguage" yaml:"messageLanguage"`
// The rule with condition and assertions to apply to template.
Rule *TemplateRule `field:"required" json:"rule" yaml:"rule"`
}
Properties for provisoning rule constraint.
Example:
import "github.com/aws/aws-cdk-go/awscdk"
var portfolio portfolio
var product cloudFormationProduct
portfolio.constrainCloudFormationParameters(product, &CloudFormationRuleConstraintOptions{
Rule: &TemplateRule{
RuleName: jsii.String("testInstanceType"),
Condition: cdk.Fn_ConditionEquals(cdk.Fn_Ref(jsii.String("Environment")), jsii.String("test")),
Assertions: []templateRuleAssertion{
&templateRuleAssertion{
Assert: cdk.Fn_ConditionContains([]*string{
jsii.String("t2.micro"),
jsii.String("t2.small"),
}, cdk.Fn_*Ref(jsii.String("InstanceType"))),
Description: jsii.String("For test environment, the instance type should be small"),
},
},
},
})
type CloudFormationTemplate ¶ added in v2.23.0
type CloudFormationTemplate interface {
// Called when the product is initialized to allow this object to bind to the stack, add resources and have fun.
Bind(scope constructs.Construct) *CloudFormationTemplateConfig
}
Represents the Product Provisioning Artifact Template.
Example:
import s3 "github.com/aws/aws-cdk-go/awscdk"
import cdk "github.com/aws/aws-cdk-go/awscdk"
type s3BucketProduct struct {
productStack
}
func newS3BucketProduct(scope construct, id *string) *s3BucketProduct {
this := &s3BucketProduct{}
servicecatalog.NewProductStack_Override(this, scope, id)
s3.NewBucket(this, jsii.String("BucketProduct"))
return this
}
product := servicecatalog.NewCloudFormationProduct(this, jsii.String("Product"), &CloudFormationProductProps{
ProductName: jsii.String("My Product"),
Owner: jsii.String("Product Owner"),
ProductVersions: []cloudFormationProductVersion{
&cloudFormationProductVersion{
ProductVersionName: jsii.String("v1"),
CloudFormationTemplate: servicecatalog.CloudFormationTemplate_FromProductStack(NewS3BucketProduct(this, jsii.String("S3BucketProduct"))),
},
},
})
func CloudFormationTemplate_FromAsset ¶ added in v2.23.0
func CloudFormationTemplate_FromAsset(path *string, options *awss3assets.AssetOptions) CloudFormationTemplate
Loads the provisioning artifacts template from a local disk path.
func CloudFormationTemplate_FromProductStack ¶ added in v2.23.0
func CloudFormationTemplate_FromProductStack(productStack ProductStack) CloudFormationTemplate
Creates a product with the resources defined in the given product stack.
func CloudFormationTemplate_FromUrl ¶ added in v2.23.0
func CloudFormationTemplate_FromUrl(url *string) CloudFormationTemplate
Template from URL.
type CloudFormationTemplateConfig ¶ added in v2.23.0
type CloudFormationTemplateConfig struct {
// The http url of the template in S3.
HttpUrl *string `field:"required" json:"httpUrl" yaml:"httpUrl"`
// The S3 bucket containing product stack assets.
AssetBucket awss3.IBucket `field:"optional" json:"assetBucket" yaml:"assetBucket"`
}
Result of binding `Template` into a `Product`.
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"
import "github.com/aws/aws-cdk-go/awscdk"
var bucket bucket
cloudFormationTemplateConfig := &CloudFormationTemplateConfig{
HttpUrl: jsii.String("httpUrl"),
// the properties below are optional
AssetBucket: bucket,
}
type CommonConstraintOptions ¶ added in v2.23.0
type CommonConstraintOptions struct {
// The description of the constraint.
Description *string `field:"optional" json:"description" yaml:"description"`
// The language code.
//
// Configures the language for error messages from service catalog.
MessageLanguage MessageLanguage `field:"optional" json:"messageLanguage" yaml:"messageLanguage"`
}
Properties for governance mechanisms and constraints.
Example:
import "github.com/aws/aws-cdk-go/awscdk"
var portfolio portfolio
var product cloudFormationProduct
topic1 := sns.NewTopic(this, jsii.String("Topic1"))
portfolio.notifyOnStackEvents(product, topic1)
topic2 := sns.NewTopic(this, jsii.String("Topic2"))
portfolio.notifyOnStackEvents(product, topic2, &CommonConstraintOptions{
Description: jsii.String("description for topic2"),
})
type IPortfolio ¶ added in v2.23.0
type IPortfolio interface {
awscdk.IResource
// Associate portfolio with the given product.
AddProduct(product IProduct)
// Associate Tag Options.
//
// A TagOption is a key-value pair managed in AWS Service Catalog.
// It is not an AWS tag, but serves as a template for creating an AWS tag based on the TagOption.
AssociateTagOptions(tagOptions TagOptions)
// Set provisioning rules for the product.
ConstrainCloudFormationParameters(product IProduct, options *CloudFormationRuleConstraintOptions)
// Add a Resource Update Constraint.
ConstrainTagUpdates(product IProduct, options *TagUpdateConstraintOptions)
// Configure deployment options using AWS Cloudformation StackSets.
DeployWithStackSets(product IProduct, options *StackSetsConstraintOptions)
// Associate portfolio with an IAM Group.
GiveAccessToGroup(group awsiam.IGroup)
// Associate portfolio with an IAM Role.
GiveAccessToRole(role awsiam.IRole)
// Associate portfolio with an IAM User.
GiveAccessToUser(user awsiam.IUser)
// Add notifications for supplied topics on the provisioned product.
NotifyOnStackEvents(product IProduct, topic awssns.ITopic, options *CommonConstraintOptions)
// Force users to assume a certain role when launching a product.
//
// This sets the launch role using the role arn which is tied to the account this role exists in.
// This is useful if you will be provisioning products from the account where this role exists.
// If you intend to share the portfolio across accounts, use a local launch role.
SetLaunchRole(product IProduct, launchRole awsiam.IRole, options *CommonConstraintOptions)
// Force users to assume a certain role when launching a product.
//
// The role name will be referenced by in the local account and must be set explicitly.
// This is useful when sharing the portfolio with multiple accounts.
SetLocalLaunchRole(product IProduct, launchRole awsiam.IRole, options *CommonConstraintOptions)
// Force users to assume a certain role when launching a product.
//
// The role will be referenced by name in the local account instead of a static role arn.
// A role with this name will automatically be created and assumable by Service Catalog in this account.
// This is useful when sharing the portfolio with multiple accounts.
SetLocalLaunchRoleName(product IProduct, launchRoleName *string, options *CommonConstraintOptions) awsiam.IRole
ShareWithAccount(accountId *string, options *PortfolioShareOptions)
// The ARN of the portfolio.
PortfolioArn() *string
// The ID of the portfolio.
PortfolioId() *string
}
A Service Catalog portfolio.
func Portfolio_FromPortfolioArn ¶ added in v2.23.0
func Portfolio_FromPortfolioArn(scope constructs.Construct, id *string, portfolioArn *string) IPortfolio
Creates a Portfolio construct that represents an external portfolio.
type IProduct ¶ added in v2.23.0
type IProduct interface {
awscdk.IResource
// Associate Tag Options.
//
// A TagOption is a key-value pair managed in AWS Service Catalog.
// It is not an AWS tag, but serves as a template for creating an AWS tag based on the TagOption.
AssociateTagOptions(tagOptions TagOptions)
// The asset buckets of a product created via product stack.
AssetBuckets() *[]awss3.IBucket
// The ARN of the product.
ProductArn() *string
// The id of the product.
ProductId() *string
}
A Service Catalog product, currently only supports type CloudFormationProduct.
func CloudFormationProduct_FromProductArn ¶ added in v2.23.0
func CloudFormationProduct_FromProductArn(scope constructs.Construct, id *string, productArn *string) IProduct
Creates a Product construct that represents an external product.
func Product_FromProductArn ¶ added in v2.23.0
func Product_FromProductArn(scope constructs.Construct, id *string, productArn *string) IProduct
Creates a Product construct that represents an external product.
type MessageLanguage ¶ added in v2.23.0
type MessageLanguage string
The language code.
Used for error and logging messages for end users. The default behavior if not specified is English.
Example:
servicecatalog.NewPortfolio(this, jsii.String("Portfolio"), &PortfolioProps{
DisplayName: jsii.String("MyFirstPortfolio"),
ProviderName: jsii.String("SCAdmin"),
Description: jsii.String("Portfolio for a project"),
MessageLanguage: servicecatalog.MessageLanguage_EN,
})
const ( // English. MessageLanguage_EN MessageLanguage = "EN" // Japanese. MessageLanguage_JP MessageLanguage = "JP" // Chinese. MessageLanguage_ZH MessageLanguage = "ZH" )
type Portfolio ¶ added in v2.23.0
type Portfolio interface {
awscdk.Resource
IPortfolio
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// The tree node.
Node() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// The ARN of the portfolio.
PortfolioArn() *string
// The ID of the portfolio.
PortfolioId() *string
// The stack in which this resource is defined.
Stack() awscdk.Stack
AddBucketPermissionsToSharedAccounts()
// Associate portfolio with the given product.
AddProduct(product IProduct)
// Apply the given removal policy to this resource.
//
// 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`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
// Associate Tag Options.
//
// A TagOption is a key-value pair managed in AWS Service Catalog.
// It is not an AWS tag, but serves as a template for creating an AWS tag based on the TagOption.
AssociateTagOptions(tagOptions TagOptions)
// Set provisioning rules for the product.
ConstrainCloudFormationParameters(product IProduct, options *CloudFormationRuleConstraintOptions)
// Add a Resource Update Constraint.
ConstrainTagUpdates(product IProduct, options *TagUpdateConstraintOptions)
// Configure deployment options using AWS Cloudformation StackSets.
DeployWithStackSets(product IProduct, options *StackSetsConstraintOptions)
GeneratePhysicalName() *string
// Create a unique id based off the L1 CfnPortfolio or the arn of an imported portfolio.
GenerateUniqueHash(value *string) *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Associate portfolio with an IAM Group.
GiveAccessToGroup(group awsiam.IGroup)
// Associate portfolio with an IAM Role.
GiveAccessToRole(role awsiam.IRole)
// Associate portfolio with an IAM User.
GiveAccessToUser(user awsiam.IUser)
// Add notifications for supplied topics on the provisioned product.
NotifyOnStackEvents(product IProduct, topic awssns.ITopic, options *CommonConstraintOptions)
// Force users to assume a certain role when launching a product.
//
// This sets the launch role using the role arn which is tied to the account this role exists in.
// This is useful if you will be provisioning products from the account where this role exists.
// If you intend to share the portfolio across accounts, use a local launch role.
SetLaunchRole(product IProduct, launchRole awsiam.IRole, options *CommonConstraintOptions)
// Force users to assume a certain role when launching a product.
//
// The role name will be referenced by in the local account and must be set explicitly.
// This is useful when sharing the portfolio with multiple accounts.
SetLocalLaunchRole(product IProduct, launchRole awsiam.IRole, options *CommonConstraintOptions)
// Force users to assume a certain role when launching a product.
//
// The role will be referenced by name in the local account instead of a static role arn.
// A role with this name will automatically be created and assumable by Service Catalog in this account.
// This is useful when sharing the portfolio with multiple accounts.
SetLocalLaunchRoleName(product IProduct, launchRoleName *string, options *CommonConstraintOptions) awsiam.IRole
ShareWithAccount(accountId *string, options *PortfolioShareOptions)
// Returns a string representation of this construct.
ToString() *string
}
A Service Catalog portfolio.
Example:
servicecatalog.NewPortfolio(this, jsii.String("Portfolio"), &PortfolioProps{
DisplayName: jsii.String("MyPortfolio"),
ProviderName: jsii.String("MyTeam"),
})
func NewPortfolio ¶ added in v2.23.0
func NewPortfolio(scope constructs.Construct, id *string, props *PortfolioProps) Portfolio
type PortfolioProps ¶ added in v2.23.0
type PortfolioProps struct {
// The name of the portfolio.
DisplayName *string `field:"required" json:"displayName" yaml:"displayName"`
// The provider name.
ProviderName *string `field:"required" json:"providerName" yaml:"providerName"`
// Description for portfolio.
Description *string `field:"optional" json:"description" yaml:"description"`
// The message language.
//
// Controls language for
// status logging and errors.
MessageLanguage MessageLanguage `field:"optional" json:"messageLanguage" yaml:"messageLanguage"`
// TagOptions associated directly to a portfolio.
TagOptions TagOptions `field:"optional" json:"tagOptions" yaml:"tagOptions"`
}
Properties for a Portfolio.
Example:
servicecatalog.NewPortfolio(this, jsii.String("Portfolio"), &PortfolioProps{
DisplayName: jsii.String("MyPortfolio"),
ProviderName: jsii.String("MyTeam"),
})
type PortfolioShareOptions ¶ added in v2.23.0
type PortfolioShareOptions struct {
//
// Controls status and error message language for share.
MessageLanguage MessageLanguage `field:"optional" json:"messageLanguage" yaml:"messageLanguage"`
ShareTagOptions *bool `field:"optional" json:"shareTagOptions" yaml:"shareTagOptions"`
}
Options for portfolio share.
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"
portfolioShareOptions := &PortfolioShareOptions{
MessageLanguage: awscdk.Aws_servicecatalog.MessageLanguage_EN,
ShareTagOptions: jsii.Boolean(false),
}
type Product ¶ added in v2.23.0
type Product interface {
awscdk.Resource
IProduct
// The asset buckets of a product created via product stack.
AssetBuckets() *[]awss3.IBucket
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// The tree node.
Node() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// The ARN of the product.
ProductArn() *string
// The id of the product.
ProductId() *string
// The stack in which this resource is defined.
Stack() awscdk.Stack
// Apply the given removal policy to this resource.
//
// 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`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
// Associate Tag Options.
//
// A TagOption is a key-value pair managed in AWS Service Catalog.
// It is not an AWS tag, but serves as a template for creating an AWS tag based on the TagOption.
AssociateTagOptions(tagOptions TagOptions)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Returns a string representation of this construct.
ToString() *string
}
Abstract class for Service Catalog Product.
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"
product := awscdk.Aws_servicecatalog.Product_FromProductArn(this, jsii.String("MyProduct"), jsii.String("productArn"))
type ProductStack ¶ added in v2.23.0
type ProductStack interface {
awscdk.Stack
// The AWS account into which this stack will be deployed.
//
// This value is resolved according to the following rules:
//
// 1. The value provided to `env.account` when the stack is defined. This can
// either be a concrete account (e.g. `585695031111`) or the
// `Aws.ACCOUNT_ID` token.
// 3. `Aws.ACCOUNT_ID`, which represents the CloudFormation intrinsic reference
// `{ "Ref": "AWS::AccountId" }` encoded as a string token.
//
// Preferably, you should use the return value as an opaque string and not
// attempt to parse it to implement your logic. If you do, you must first
// check that it is a concrete value an not an unresolved token. If this
// value is an unresolved token (`Token.isUnresolved(stack.account)` returns
// `true`), this implies that the user wishes that this stack will synthesize
// into a **account-agnostic template**. In this case, your code should either
// fail (throw an error, emit a synth error using `Annotations.of(construct).addError()`) or
// implement some other region-agnostic behavior.
Account() *string
// The ID of the cloud assembly artifact for this stack.
ArtifactId() *string
// Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.
//
// If the stack is environment-agnostic (either account and/or region are
// tokens), this property will return an array with 2 tokens that will resolve
// at deploy-time to the first two availability zones returned from CloudFormation's
// `Fn::GetAZs` intrinsic function.
//
// If they are not available in the context, returns a set of dummy values and
// reports them as missing, and let the CLI resolve them by calling EC2
// `DescribeAvailabilityZones` on the target environment.
//
// To specify a different strategy for selecting availability zones override this method.
AvailabilityZones() *[]*string
// Indicates whether the stack requires bundling or not.
BundlingRequired() *bool
// Return the stacks this stack depends on.
Dependencies() *[]awscdk.Stack
// The environment coordinates in which this stack is deployed.
//
// In the form
// `aws://account/region`. Use `stack.account` and `stack.region` to obtain
// the specific values, no need to parse.
//
// You can use this value to determine if two stacks are targeting the same
// environment.
//
// If either `stack.account` or `stack.region` are not concrete values (e.g.
// `Aws.ACCOUNT_ID` or `Aws.REGION`) the special strings `unknown-account` and/or
// `unknown-region` will be used respectively to indicate this stack is
// region/account-agnostic.
Environment() *string
// Indicates if this is a nested stack, in which case `parentStack` will include a reference to it's parent.
Nested() *bool
// If this is a nested stack, returns it's parent stack.
NestedStackParent() awscdk.Stack
// If this is a nested stack, this represents its `AWS::CloudFormation::Stack` resource.
//
// `undefined` for top-level (non-nested) stacks.
NestedStackResource() awscdk.CfnResource
// The tree node.
Node() constructs.Node
// Returns the list of notification Amazon Resource Names (ARNs) for the current stack.
NotificationArns() *[]*string
// The partition in which this stack is defined.
Partition() *string
// The AWS region into which this stack will be deployed (e.g. `us-west-2`).
//
// This value is resolved according to the following rules:
//
// 1. The value provided to `env.region` when the stack is defined. This can
// either be a concrete region (e.g. `us-west-2`) or the `Aws.REGION`
// token.
// 3. `Aws.REGION`, which is represents the CloudFormation intrinsic reference
// `{ "Ref": "AWS::Region" }` encoded as a string token.
//
// Preferably, you should use the return value as an opaque string and not
// attempt to parse it to implement your logic. If you do, you must first
// check that it is a concrete value an not an unresolved token. If this
// value is an unresolved token (`Token.isUnresolved(stack.region)` returns
// `true`), this implies that the user wishes that this stack will synthesize
// into a **region-agnostic template**. In this case, your code should either
// fail (throw an error, emit a synth error using `Annotations.of(construct).addError()`) or
// implement some other region-agnostic behavior.
Region() *string
// The ID of the stack.
//
// Example:
// // After resolving, looks like
// 'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
//
StackId() *string
// The concrete CloudFormation physical stack name.
//
// This is either the name defined explicitly in the `stackName` prop or
// allocated based on the stack's location in the construct tree. Stacks that
// are directly defined under the app use their construct `id` as their stack
// name. Stacks that are defined deeper within the tree will use a hashed naming
// scheme based on the construct path to ensure uniqueness.
//
// If you wish to obtain the deploy-time AWS::StackName intrinsic,
// you can use `Aws.STACK_NAME` directly.
StackName() *string
// Synthesis method for this stack.
Synthesizer() awscdk.IStackSynthesizer
// Tags to be applied to the stack.
Tags() awscdk.TagManager
// The name of the CloudFormation template file emitted to the output directory during synthesis.
//
// Example value: `MyStack.template.json`
TemplateFile() *string
// Options for CloudFormation template (like version, transform, description).
TemplateOptions() awscdk.ITemplateOptions
// Whether termination protection is enabled for this stack.
TerminationProtection() *bool
// The Amazon domain suffix for the region in which this stack is defined.
UrlSuffix() *string
// Add a dependency between this stack and another stack.
//
// This can be used to define dependencies between any two stacks within an
// app, and also supports nested stacks.
AddDependency(target awscdk.Stack, reason *string)
// Adds an arbitary key-value pair, with information you want to record about the stack.
//
// These get translated to the Metadata section of the generated template.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
AddMetadata(key *string, value interface{})
// Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template.
//
// Duplicate values are removed when stack is synthesized.
//
// Example:
// declare const stack: Stack;
//
// stack.addTransform('AWS::Serverless-2016-10-31')
//
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html
//
AddTransform(transform *string)
// Returns the naming scheme used to allocate logical IDs.
//
// By default, uses
// the `HashedAddressingScheme` but this method can be overridden to customize
// this behavior.
//
// In order to make sure logical IDs are unique and stable, we hash the resource
// construct tree path (i.e. toplevel/secondlevel/.../myresource) and add it as
// a suffix to the path components joined without a separator (CloudFormation
// IDs only allow alphanumeric characters).
//
// The result will be:
//
// <path.join(”)><md5(path.join('/')>
// "human" "hash"
//
// If the "human" part of the ID exceeds 240 characters, we simply trim it so
// the total ID doesn't exceed CloudFormation's 255 character limit.
//
// We only take 8 characters from the md5 hash (0.000005 chance of collision).
//
// Special cases:
//
// - If the path only contains a single component (i.e. it's a top-level
// resource), we won't add the hash to it. The hash is not needed for
// disambiguation and also, it allows for a more straightforward migration an
// existing CloudFormation template to a CDK stack without logical ID changes
// (or renames).
// - For aesthetic reasons, if the last components of the path are the same
// (i.e. `L1/L2/Pipeline/Pipeline`), they will be de-duplicated to make the
// resulting human portion of the ID more pleasing: `L1L2Pipeline<HASH>`
// instead of `L1L2PipelinePipeline<HASH>`
// - If a component is named "Default" it will be omitted from the path. This
// allows refactoring higher level abstractions around constructs without affecting
// the IDs of already deployed resources.
// - If a component is named "Resource" it will be omitted from the user-visible
// path, but included in the hash. This reduces visual noise in the human readable
// part of the identifier.
AllocateLogicalId(cfnElement awscdk.CfnElement) *string
// Create a CloudFormation Export for a string list value.
//
// Returns a string list representing the corresponding `Fn.importValue()`
// expression for this Export. The export expression is automatically wrapped with an
// `Fn::Join` and the import value with an `Fn::Split`, since CloudFormation can only
// export strings. You can control the name for the export by passing the `name` option.
//
// If you don't supply a value for `name`, the value you're exporting must be
// a Resource attribute (for example: `bucket.bucketName`) and it will be
// given the same name as the automatic cross-stack reference that would be created
// if you used the attribute in another Stack.
//
// One of the uses for this method is to *remove* the relationship between
// two Stacks established by automatic cross-stack references. It will
// temporarily ensure that the CloudFormation Export still exists while you
// remove the reference from the consuming stack. After that, you can remove
// the resource and the manual export.
//
// See `exportValue` for an example of this process.
ExportStringListValue(exportedValue interface{}, options *awscdk.ExportValueOptions) *[]*string
// Create a CloudFormation Export for a string value.
//
// Returns a string representing the corresponding `Fn.importValue()`
// expression for this Export. You can control the name for the export by
// passing the `name` option.
//
// If you don't supply a value for `name`, the value you're exporting must be
// a Resource attribute (for example: `bucket.bucketName`) and it will be
// given the same name as the automatic cross-stack reference that would be created
// if you used the attribute in another Stack.
//
// One of the uses for this method is to *remove* the relationship between
// two Stacks established by automatic cross-stack references. It will
// temporarily ensure that the CloudFormation Export still exists while you
// remove the reference from the consuming stack. After that, you can remove
// the resource and the manual export.
//
// ## Example
//
// Here is how the process works. Let's say there are two stacks,
// `producerStack` and `consumerStack`, and `producerStack` has a bucket
// called `bucket`, which is referenced by `consumerStack` (perhaps because
// an AWS Lambda Function writes into it, or something like that).
//
// It is not safe to remove `producerStack.bucket` because as the bucket is being
// deleted, `consumerStack` might still be using it.
//
// Instead, the process takes two deployments:
//
// ### Deployment 1: break the relationship
//
// - Make sure `consumerStack` no longer references `bucket.bucketName` (maybe the consumer
// stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just
// remove the Lambda Function altogether).
// - In the `ProducerStack` class, call `this.exportValue(this.bucket.bucketName)`. This
// will make sure the CloudFormation Export continues to exist while the relationship
// between the two stacks is being broken.
// - Deploy (this will effectively only change the `consumerStack`, but it's safe to deploy both).
//
// ### Deployment 2: remove the bucket resource
//
// - You are now free to remove the `bucket` resource from `producerStack`.
// - Don't forget to remove the `exportValue()` call as well.
// - Deploy again (this time only the `producerStack` will be changed -- the bucket will be deleted).
ExportValue(exportedValue interface{}, options *awscdk.ExportValueOptions) *string
// Creates an ARN from components.
//
// If `partition`, `region` or `account` are not specified, the stack's
// partition, region and account will be used.
//
// If any component is the empty string, an empty string will be inserted
// into the generated ARN at the location that component corresponds to.
//
// The ARN will be formatted as follows:
//
// arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}
//
// The required ARN pieces that are omitted will be taken from the stack that
// the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope
// can be 'undefined'.
FormatArn(components *awscdk.ArnComponents) *string
// Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.
//
// This method is called when a `CfnElement` is created and used to render the
// initial logical identity of resources. Logical ID renames are applied at
// this stage.
//
// This method uses the protected method `allocateLogicalId` to render the
// logical ID for an element. To modify the naming scheme, extend the `Stack`
// class and override this method.
GetLogicalId(element awscdk.CfnElement) *string
// Look up a fact value for the given fact for the region of this stack.
//
// Will return a definite value only if the region of the current stack is resolved.
// If not, a lookup map will be added to the stack and the lookup will be done at
// CDK deployment time.
//
// What regions will be included in the lookup map is controlled by the
// `@aws-cdk/core:target-partitions` context value: it must be set to a list
// of partitions, and only regions from the given partitions will be included.
// If no such context key is set, all regions will be included.
//
// This function is intended to be used by construct library authors. Application
// builders can rely on the abstractions offered by construct libraries and do
// not have to worry about regional facts.
//
// If `defaultValue` is not given, it is an error if the fact is unknown for
// the given region.
RegionalFact(factName *string, defaultValue *string) *string
// Rename a generated logical identities.
//
// To modify the naming scheme strategy, extend the `Stack` class and
// override the `allocateLogicalId` method.
RenameLogicalId(oldId *string, newId *string)
// Indicate that a context key was expected.
//
// Contains instructions which will be emitted into the cloud assembly on how
// the key should be supplied.
ReportMissingContextKey(report *cloudassemblyschema.MissingContext)
// Resolve a tokenized value in the context of the current stack.
Resolve(obj interface{}) interface{}
// Splits the provided ARN into its components.
//
// Works both if 'arn' is a string like 'arn:aws:s3:::bucket',
// and a Token representing a dynamic CloudFormation expression
// (in which case the returned components will also be dynamic CloudFormation expressions,
// encoded as Tokens).
SplitArn(arn *string, arnFormat awscdk.ArnFormat) *awscdk.ArnComponents
// Convert an object, potentially containing tokens, to a JSON string.
ToJsonString(obj interface{}, space *float64) *string
// Returns a string representation of this construct.
ToString() *string
// Convert an object, potentially containing tokens, to a YAML string.
ToYamlString(obj interface{}) *string
}
A Service Catalog product stack, which is similar in form to a Cloudformation nested stack.
You can add the resources to this stack that you want to define for your service catalog product.
This stack will not be treated as an independent deployment artifact (won't be listed in "cdk list" or deployable through "cdk deploy"), but rather only synthesized as a template and uploaded as an asset to S3.
Example:
// Example automatically generated from non-compiling source. May contain errors.
import s3 "github.com/aws/aws-cdk-go/awscdk"
import cdk "github.com/aws/aws-cdk-go/awscdk"
type s3BucketProduct struct {
productStack
}
func newS3BucketProduct(scope cdk.Construct, id *string) *s3BucketProduct {
this := &s3BucketProduct{}
servicecatalog.NewProductStack_Override(this, scope, id)
s3.NewBucket(this, jsii.String("BucketProductV2"))
return this
}
productStackHistory := servicecatalog.NewProductStackHistory(this, jsii.String("ProductStackHistory"), &ProductStackHistoryProps{
ProductStack: NewS3BucketProduct(this, jsii.String("S3BucketProduct")),
CurrentVersionName: jsii.String("v2"),
CurrentVersionLocked: jsii.Boolean(true),
})
product := servicecatalog.NewCloudFormationProduct(this, jsii.String("MyFirstProduct"), &CloudFormationProductProps{
ProductName: jsii.String("My Product"),
Owner: jsii.String("Product Owner"),
ProductVersions: []cloudFormationProductVersion{
productStackHistory.CurrentVersion(),
},
})
func NewProductStack ¶ added in v2.23.0
func NewProductStack(scope constructs.Construct, id *string, props *ProductStackProps) ProductStack
type ProductStackHistory ¶ added in v2.26.0
type ProductStackHistory interface {
constructs.Construct
// The tree node.
Node() constructs.Node
// Retains product stack template as a snapshot when deployed and retrieves a CloudFormationProductVersion for the current product version.
CurrentVersion() *CloudFormationProductVersion
// Returns a string representation of this construct.
ToString() *string
// Retrieves a CloudFormationProductVersion from a previously deployed productVersionName.
VersionFromSnapshot(productVersionName *string) *CloudFormationProductVersion
}
A Construct that contains a Service Catalog product stack with its previous deployments maintained.
Example:
// Example automatically generated from non-compiling source. May contain errors.
import s3 "github.com/aws/aws-cdk-go/awscdk"
import cdk "github.com/aws/aws-cdk-go/awscdk"
type s3BucketProduct struct {
productStack
}
func newS3BucketProduct(scope cdk.Construct, id *string) *s3BucketProduct {
this := &s3BucketProduct{}
servicecatalog.NewProductStack_Override(this, scope, id)
s3.NewBucket(this, jsii.String("BucketProductV2"))
return this
}
productStackHistory := servicecatalog.NewProductStackHistory(this, jsii.String("ProductStackHistory"), &ProductStackHistoryProps{
ProductStack: NewS3BucketProduct(this, jsii.String("S3BucketProduct")),
CurrentVersionName: jsii.String("v2"),
CurrentVersionLocked: jsii.Boolean(true),
})
product := servicecatalog.NewCloudFormationProduct(this, jsii.String("MyFirstProduct"), &CloudFormationProductProps{
ProductName: jsii.String("My Product"),
Owner: jsii.String("Product Owner"),
ProductVersions: []cloudFormationProductVersion{
productStackHistory.CurrentVersion(),
},
})
func NewProductStackHistory ¶ added in v2.26.0
func NewProductStackHistory(scope constructs.Construct, id *string, props *ProductStackHistoryProps) ProductStackHistory
type ProductStackHistoryProps ¶ added in v2.26.0
type ProductStackHistoryProps struct {
// If this is set to true, the ProductStack will not be overwritten if a snapshot is found for the currentVersionName.
CurrentVersionLocked *bool `field:"required" json:"currentVersionLocked" yaml:"currentVersionLocked"`
// The current version name of the ProductStack.
CurrentVersionName *string `field:"required" json:"currentVersionName" yaml:"currentVersionName"`
// The ProductStack whose history will be retained as a snapshot.
ProductStack ProductStack `field:"required" json:"productStack" yaml:"productStack"`
// The description of the product version.
Description *string `field:"optional" json:"description" yaml:"description"`
// The directory where template snapshots will be stored.
Directory *string `field:"optional" json:"directory" yaml:"directory"`
// Whether the specified product template will be validated by CloudFormation.
//
// If turned off, an invalid template configuration can be stored.
ValidateTemplate *bool `field:"optional" json:"validateTemplate" yaml:"validateTemplate"`
}
Properties for a ProductStackHistory.
Example:
// Example automatically generated from non-compiling source. May contain errors.
import s3 "github.com/aws/aws-cdk-go/awscdk"
import cdk "github.com/aws/aws-cdk-go/awscdk"
type s3BucketProduct struct {
productStack
}
func newS3BucketProduct(scope cdk.Construct, id *string) *s3BucketProduct {
this := &s3BucketProduct{}
servicecatalog.NewProductStack_Override(this, scope, id)
s3.NewBucket(this, jsii.String("BucketProductV2"))
return this
}
productStackHistory := servicecatalog.NewProductStackHistory(this, jsii.String("ProductStackHistory"), &ProductStackHistoryProps{
ProductStack: NewS3BucketProduct(this, jsii.String("S3BucketProduct")),
CurrentVersionName: jsii.String("v2"),
CurrentVersionLocked: jsii.Boolean(true),
})
product := servicecatalog.NewCloudFormationProduct(this, jsii.String("MyFirstProduct"), &CloudFormationProductProps{
ProductName: jsii.String("My Product"),
Owner: jsii.String("Product Owner"),
ProductVersions: []cloudFormationProductVersion{
productStackHistory.CurrentVersion(),
},
})
type ProductStackProps ¶ added in v2.59.0
type ProductStackProps struct {
// A Bucket can be passed to store assets, enabling ProductStack Asset support.
AssetBucket awss3.IBucket `field:"optional" json:"assetBucket" yaml:"assetBucket"`
}
Product stack props.
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"
import "github.com/aws/aws-cdk-go/awscdk"
var bucket bucket
productStackProps := &ProductStackProps{
AssetBucket: bucket,
}
type StackSetsConstraintOptions ¶ added in v2.23.0
type StackSetsConstraintOptions struct {
// The description of the constraint.
Description *string `field:"optional" json:"description" yaml:"description"`
// The language code.
//
// Configures the language for error messages from service catalog.
MessageLanguage MessageLanguage `field:"optional" json:"messageLanguage" yaml:"messageLanguage"`
// List of accounts to deploy stacks to.
Accounts *[]*string `field:"required" json:"accounts" yaml:"accounts"`
// IAM role used to administer the StackSets configuration.
AdminRole awsiam.IRole `field:"required" json:"adminRole" yaml:"adminRole"`
// IAM role used to provision the products in the Stacks.
ExecutionRoleName *string `field:"required" json:"executionRoleName" yaml:"executionRoleName"`
// List of regions to deploy stacks to.
Regions *[]*string `field:"required" json:"regions" yaml:"regions"`
// Wether to allow end users to create, update, and delete stacks.
AllowStackSetInstanceOperations *bool `field:"optional" json:"allowStackSetInstanceOperations" yaml:"allowStackSetInstanceOperations"`
}
Properties for deploying with Stackset, which creates a StackSet constraint.
Example:
import "github.com/aws/aws-cdk-go/awscdk"
var portfolio portfolio
var product cloudFormationProduct
adminRole := iam.NewRole(this, jsii.String("AdminRole"), &RoleProps{
AssumedBy: iam.NewAccountRootPrincipal(),
})
portfolio.deployWithStackSets(product, &StackSetsConstraintOptions{
Accounts: []*string{
jsii.String("012345678901"),
jsii.String("012345678902"),
jsii.String("012345678903"),
},
Regions: []*string{
jsii.String("us-west-1"),
jsii.String("us-east-1"),
jsii.String("us-west-2"),
jsii.String("us-east-1"),
},
AdminRole: adminRole,
ExecutionRoleName: jsii.String("SCStackSetExecutionRole"),
// Name of role deployed in end users accounts.
AllowStackSetInstanceOperations: jsii.Boolean(true),
})
type TagOptions ¶ added in v2.23.0
type TagOptions interface {
awscdk.Resource
// The environment this resource belongs to.
//
// For resources that are created and managed by the CDK
// (generally, those created by creating new class instances like Role, Bucket, etc.),
// this is always the same as the environment of the stack they belong to;
// however, for imported resources
// (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
// that might be different than the stack they were imported into.
Env() *awscdk.ResourceEnvironment
// The tree node.
Node() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// The stack in which this resource is defined.
Stack() awscdk.Stack
// Apply the given removal policy to this resource.
//
// 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`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Returns a string representation of this construct.
ToString() *string
}
Defines a set of TagOptions, which are a list of key-value pairs managed in AWS Service Catalog.
It is not an AWS tag, but serves as a template for creating an AWS tag based on the TagOption. See https://docs.aws.amazon.com/servicecatalog/latest/adminguide/tagoptions.html
Example:
var portfolio portfolio
var product cloudFormationProduct
tagOptionsForPortfolio := servicecatalog.NewTagOptions(this, jsii.String("OrgTagOptions"), &TagOptionsProps{
AllowedValuesForTags: map[string][]*string{
"Group": []*string{
jsii.String("finance"),
jsii.String("engineering"),
jsii.String("marketing"),
jsii.String("research"),
},
"CostCenter": []*string{
jsii.String("01"),
jsii.String("02"),
jsii.String("03"),
},
},
})
portfolio.associateTagOptions(tagOptionsForPortfolio)
tagOptionsForProduct := servicecatalog.NewTagOptions(this, jsii.String("ProductTagOptions"), &TagOptionsProps{
AllowedValuesForTags: map[string][]*string{
"Environment": []*string{
jsii.String("dev"),
jsii.String("alpha"),
jsii.String("prod"),
},
},
})
product.associateTagOptions(tagOptionsForProduct)
func NewTagOptions ¶ added in v2.23.0
func NewTagOptions(scope constructs.Construct, id *string, props *TagOptionsProps) TagOptions
type TagOptionsProps ¶ added in v2.23.0
type TagOptionsProps struct {
// The values that are allowed to be set for specific tags.
//
// The keys of the map represent the tag keys,
// and the values of the map are a list of allowed values for that particular tag key.
AllowedValuesForTags *map[string]*[]*string `field:"required" json:"allowedValuesForTags" yaml:"allowedValuesForTags"`
}
Properties for TagOptions.
Example:
var portfolio portfolio
var product cloudFormationProduct
tagOptionsForPortfolio := servicecatalog.NewTagOptions(this, jsii.String("OrgTagOptions"), &TagOptionsProps{
AllowedValuesForTags: map[string][]*string{
"Group": []*string{
jsii.String("finance"),
jsii.String("engineering"),
jsii.String("marketing"),
jsii.String("research"),
},
"CostCenter": []*string{
jsii.String("01"),
jsii.String("02"),
jsii.String("03"),
},
},
})
portfolio.associateTagOptions(tagOptionsForPortfolio)
tagOptionsForProduct := servicecatalog.NewTagOptions(this, jsii.String("ProductTagOptions"), &TagOptionsProps{
AllowedValuesForTags: map[string][]*string{
"Environment": []*string{
jsii.String("dev"),
jsii.String("alpha"),
jsii.String("prod"),
},
},
})
product.associateTagOptions(tagOptionsForProduct)
type TagUpdateConstraintOptions ¶ added in v2.23.0
type TagUpdateConstraintOptions struct {
// The description of the constraint.
Description *string `field:"optional" json:"description" yaml:"description"`
// The language code.
//
// Configures the language for error messages from service catalog.
MessageLanguage MessageLanguage `field:"optional" json:"messageLanguage" yaml:"messageLanguage"`
// Toggle for if users should be allowed to change/update tags on provisioned products.
Allow *bool `field:"optional" json:"allow" yaml:"allow"`
}
Properties for ResourceUpdateConstraint.
Example:
var portfolio portfolio
var product cloudFormationProduct
// to disable tag updates:
portfolio.constrainTagUpdates(product, &TagUpdateConstraintOptions{
Allow: jsii.Boolean(false),
})
type TemplateRule ¶ added in v2.23.0
type TemplateRule struct {
// A list of assertions that make up the rule.
Assertions *[]*TemplateRuleAssertion `field:"required" json:"assertions" yaml:"assertions"`
// Name of the rule.
RuleName *string `field:"required" json:"ruleName" yaml:"ruleName"`
// Specify when to apply rule with a rule-specific intrinsic function.
Condition awscdk.ICfnRuleConditionExpression `field:"optional" json:"condition" yaml:"condition"`
}
Defines the provisioning template constraints.
Example:
import "github.com/aws/aws-cdk-go/awscdk"
var portfolio portfolio
var product cloudFormationProduct
portfolio.constrainCloudFormationParameters(product, &CloudFormationRuleConstraintOptions{
Rule: &TemplateRule{
RuleName: jsii.String("testInstanceType"),
Condition: cdk.Fn_ConditionEquals(cdk.Fn_Ref(jsii.String("Environment")), jsii.String("test")),
Assertions: []templateRuleAssertion{
&templateRuleAssertion{
Assert: cdk.Fn_ConditionContains([]*string{
jsii.String("t2.micro"),
jsii.String("t2.small"),
}, cdk.Fn_*Ref(jsii.String("InstanceType"))),
Description: jsii.String("For test environment, the instance type should be small"),
},
},
},
})
type TemplateRuleAssertion ¶ added in v2.23.0
type TemplateRuleAssertion struct {
// The assertion condition.
Assert awscdk.ICfnRuleConditionExpression `field:"required" json:"assert" yaml:"assert"`
// The description for the asssertion.
Description *string `field:"optional" json:"description" yaml:"description"`
}
An assertion within a template rule, defined by intrinsic functions.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var cfnRuleConditionExpression iCfnRuleConditionExpression
templateRuleAssertion := &TemplateRuleAssertion{
Assert: cfnRuleConditionExpression,
// the properties below are optional
Description: jsii.String("description"),
}
Source Files
¶
- CfnAcceptedPortfolioShare.go
- CfnAcceptedPortfolioShareProps.go
- CfnAcceptedPortfolioShare__checks.go
- CfnCloudFormationProduct.go
- CfnCloudFormationProductProps.go
- CfnCloudFormationProduct_CodeStarParametersProperty.go
- CfnCloudFormationProduct_ConnectionParametersProperty.go
- CfnCloudFormationProduct_ProvisioningArtifactPropertiesProperty.go
- CfnCloudFormationProduct_SourceConnectionProperty.go
- CfnCloudFormationProduct__checks.go
- CfnCloudFormationProvisionedProduct.go
- CfnCloudFormationProvisionedProductProps.go
- CfnCloudFormationProvisionedProduct_ProvisioningParameterProperty.go
- CfnCloudFormationProvisionedProduct_ProvisioningPreferencesProperty.go
- CfnCloudFormationProvisionedProduct__checks.go
- CfnLaunchNotificationConstraint.go
- CfnLaunchNotificationConstraintProps.go
- CfnLaunchNotificationConstraint__checks.go
- CfnLaunchRoleConstraint.go
- CfnLaunchRoleConstraintProps.go
- CfnLaunchRoleConstraint__checks.go
- CfnLaunchTemplateConstraint.go
- CfnLaunchTemplateConstraintProps.go
- CfnLaunchTemplateConstraint__checks.go
- CfnPortfolio.go
- CfnPortfolioPrincipalAssociation.go
- CfnPortfolioPrincipalAssociationProps.go
- CfnPortfolioPrincipalAssociation__checks.go
- CfnPortfolioProductAssociation.go
- CfnPortfolioProductAssociationProps.go
- CfnPortfolioProductAssociation__checks.go
- CfnPortfolioProps.go
- CfnPortfolioShare.go
- CfnPortfolioShareProps.go
- CfnPortfolioShare__checks.go
- CfnPortfolio__checks.go
- CfnResourceUpdateConstraint.go
- CfnResourceUpdateConstraintProps.go
- CfnResourceUpdateConstraint__checks.go
- CfnServiceAction.go
- CfnServiceActionAssociation.go
- CfnServiceActionAssociationProps.go
- CfnServiceActionAssociation__checks.go
- CfnServiceActionProps.go
- CfnServiceAction_DefinitionParameterProperty.go
- CfnServiceAction__checks.go
- CfnStackSetConstraint.go
- CfnStackSetConstraintProps.go
- CfnStackSetConstraint__checks.go
- CfnTagOption.go
- CfnTagOptionAssociation.go
- CfnTagOptionAssociationProps.go
- CfnTagOptionAssociation__checks.go
- CfnTagOptionProps.go
- CfnTagOption__checks.go
- CloudFormationProduct.go
- CloudFormationProductProps.go
- CloudFormationProductVersion.go
- CloudFormationProduct__checks.go
- CloudFormationRuleConstraintOptions.go
- CloudFormationTemplate.go
- CloudFormationTemplateConfig.go
- CloudFormationTemplate__checks.go
- CommonConstraintOptions.go
- IPortfolio.go
- IPortfolio__checks.go
- IProduct.go
- IProduct__checks.go
- MessageLanguage.go
- Portfolio.go
- PortfolioProps.go
- PortfolioShareOptions.go
- Portfolio__checks.go
- Product.go
- ProductStack.go
- ProductStackHistory.go
- ProductStackHistoryProps.go
- ProductStackHistory__checks.go
- ProductStackProps.go
- ProductStack__checks.go
- Product__checks.go
- StackSetsConstraintOptions.go
- TagOptions.go
- TagOptionsProps.go
- TagOptions__checks.go
- TagUpdateConstraintOptions.go
- TemplateRule.go
- TemplateRuleAssertion.go
- main.go