Class CfnCloudFormationProvisionedProduct
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
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 .
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 software.amazon.awscdk.services.servicecatalog.*; CfnCloudFormationProvisionedProduct cfnCloudFormationProvisionedProduct = CfnCloudFormationProvisionedProduct.Builder.create(this, "MyCfnCloudFormationProvisionedProduct") .acceptLanguage("acceptLanguage") .notificationArns(List.of("notificationArns")) .pathId("pathId") .pathName("pathName") .productId("productId") .productName("productName") .provisionedProductName("provisionedProductName") .provisioningArtifactId("provisioningArtifactId") .provisioningArtifactName("provisioningArtifactName") .provisioningParameters(List.of(ProvisioningParameterProperty.builder() .key("key") .value("value") .build())) .provisioningPreferences(ProvisioningPreferencesProperty.builder() .stackSetAccounts(List.of("stackSetAccounts")) .stackSetFailureToleranceCount(123) .stackSetFailureTolerancePercentage(123) .stackSetMaxConcurrencyCount(123) .stackSetMaxConcurrencyPercentage(123) .stackSetOperationType("stackSetOperationType") .stackSetRegions(List.of("stackSetRegions")) .build()) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
A fluent builder forCfnCloudFormationProvisionedProduct
.static interface
Information about a parameter used to provision a product.static interface
The user-defined preferences that will be applied when updating a provisioned product.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionCfnCloudFormationProvisionedProduct
(Construct scope, String id) Create a newAWS::ServiceCatalog::CloudFormationProvisionedProduct
.CfnCloudFormationProvisionedProduct
(Construct scope, String id, CfnCloudFormationProvisionedProductProps props) Create a newAWS::ServiceCatalog::CloudFormationProvisionedProduct
.protected
CfnCloudFormationProvisionedProduct
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnCloudFormationProvisionedProduct
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionThe language code.The Amazon Resource Name (ARN) of the CloudFormation stack, such asarn:aws:cloudformation:eu-west-1:123456789012:stack/SC-499278721343-pp-hfyszaotincww/8f3df460-346a-11e8-9444-503abe701c29
.The output of the product you are provisioning.The ID of the provisioned product.The ID of the record, such asrec-rjeatvy434trk
.Passed to AWS CloudFormation .The path identifier of the product.The name of the path.The product identifier.The name of the Service Catalog product.A user-friendly name for the provisioned product.The identifier of the provisioning artifact (also known as a version).The name of the provisioning artifact (also known as a version) for the product.Parameters specified by the administrator that are required for provisioning the product.StackSet preferences that are required for provisioning the product or updating a provisioned product.getTags()
One or more tags.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setAcceptLanguage
(String value) The language code.void
setNotificationArns
(List<String> value) Passed to AWS CloudFormation .void
The path identifier of the product.void
setPathName
(String value) The name of the path.void
setProductId
(String value) The product identifier.void
setProductName
(String value) The name of the Service Catalog product.void
setProvisionedProductName
(String value) A user-friendly name for the provisioned product.void
setProvisioningArtifactId
(String value) The identifier of the provisioning artifact (also known as a version).void
The name of the provisioning artifact (also known as a version) for the product.void
setProvisioningParameters
(List<Object> value) Parameters specified by the administrator that are required for provisioning the product.void
Parameters specified by the administrator that are required for provisioning the product.void
StackSet preferences that are required for provisioning the product or updating a provisioned product.void
setProvisioningPreferences
(CfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty value) StackSet preferences that are required for provisioning the product or updating a provisioned product.Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnCloudFormationProvisionedProduct
protected CfnCloudFormationProvisionedProduct(software.amazon.jsii.JsiiObjectRef objRef) -
CfnCloudFormationProvisionedProduct
protected CfnCloudFormationProvisionedProduct(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnCloudFormationProvisionedProduct
@Stability(Stable) public CfnCloudFormationProvisionedProduct(@NotNull Construct scope, @NotNull String id, @Nullable CfnCloudFormationProvisionedProductProps props) Create a newAWS::ServiceCatalog::CloudFormationProvisionedProduct
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
CfnCloudFormationProvisionedProduct
@Stability(Stable) public CfnCloudFormationProvisionedProduct(@NotNull Construct scope, @NotNull String id) Create a newAWS::ServiceCatalog::CloudFormationProvisionedProduct
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrCloudformationStackArn
The Amazon Resource Name (ARN) of the CloudFormation stack, such asarn:aws:cloudformation:eu-west-1:123456789012:stack/SC-499278721343-pp-hfyszaotincww/8f3df460-346a-11e8-9444-503abe701c29
. -
getAttrOutputs
The output of the product you are provisioning.For example, the DNS of an EC2 instance.
-
getAttrProvisionedProductId
The ID of the provisioned product. -
getAttrRecordId
The ID of the record, such asrec-rjeatvy434trk
. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
One or more tags.Requires the provisioned product to have an ResourceUpdateConstraint resource with
TagUpdatesOnProvisionedProduct
set toALLOWED
to allow tag updates. IfRESOURCE_UPDATE
constraint is not present, tags updates are ignored. -
getAcceptLanguage
The language code.jp
- Japanesezh
- Chinese
-
setAcceptLanguage
The language code.jp
- Japanesezh
- Chinese
-
getNotificationArns
Passed to AWS CloudFormation .The SNS topic ARNs to which to publish stack-related events.
-
setNotificationArns
Passed to AWS CloudFormation .The SNS topic ARNs to which to publish stack-related events.
-
getPathId
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 .
You must provide the name or ID, but not both.
-
setPathId
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 .
You must provide the name or ID, but not both.
-
getPathName
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 .
You must provide the name or ID, but not both.
-
setPathName
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 .
You must provide the name or ID, but not both.
-
getProductId
The product identifier.You must specify either the ID or the name of the product, but not both.
-
setProductId
The product identifier.You must specify either the ID or the name of the product, but not both.
-
getProductName
The name of the Service Catalog product.Each time a stack is created or updated, if
ProductName
is provided it will successfully resolve toProductId
as long as only one product exists in the account or Region with thatProductName
.You must specify either the name or the ID of the product, but not both.
-
setProductName
The name of the Service Catalog product.Each time a stack is created or updated, if
ProductName
is provided it will successfully resolve toProductId
as long as only one product exists in the account or Region with thatProductName
.You must specify either the name or the ID of the product, but not both.
-
getProvisionedProductName
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.
-
setProvisionedProductName
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.
-
getProvisioningArtifactId
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.
-
setProvisioningArtifactId
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.
-
getProvisioningArtifactName
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.
-
setProvisioningArtifactName
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.
-
getProvisioningParameters
Parameters specified by the administrator that are required for provisioning the product. -
setProvisioningParameters
Parameters specified by the administrator that are required for provisioning the product. -
setProvisioningParameters
Parameters specified by the administrator that are required for provisioning the product. -
getProvisioningPreferences
StackSet preferences that are required for provisioning the product or updating a provisioned product. -
setProvisioningPreferences
StackSet preferences that are required for provisioning the product or updating a provisioned product. -
setProvisioningPreferences
@Stability(Stable) public void setProvisioningPreferences(@Nullable CfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty value) StackSet preferences that are required for provisioning the product or updating a provisioned product.
-