Class CfnCloudFormationProvisionedProduct
A CloudFormation AWS::ServiceCatalog::CloudFormationProvisionedProduct
.
Inheritance
Inherited Members
Namespace: Amazon.CDK.AWS.ServiceCatalog
Assembly: Amazon.CDK.AWS.ServiceCatalog.dll
Syntax (csharp)
public class CfnCloudFormationProvisionedProduct : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnCloudFormationProvisionedProduct
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 ".
CloudformationResource: AWS::ServiceCatalog::CloudFormationProvisionedProduct
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ServiceCatalog;
var cfnCloudFormationProvisionedProduct = new CfnCloudFormationProvisionedProduct(this, "MyCfnCloudFormationProvisionedProduct", new CfnCloudFormationProvisionedProductProps {
AcceptLanguage = "acceptLanguage",
NotificationArns = new [] { "notificationArns" },
PathId = "pathId",
PathName = "pathName",
ProductId = "productId",
ProductName = "productName",
ProvisionedProductName = "provisionedProductName",
ProvisioningArtifactId = "provisioningArtifactId",
ProvisioningArtifactName = "provisioningArtifactName",
ProvisioningParameters = new [] { new ProvisioningParameterProperty {
Key = "key",
Value = "value"
} },
ProvisioningPreferences = new ProvisioningPreferencesProperty {
StackSetAccounts = new [] { "stackSetAccounts" },
StackSetFailureToleranceCount = 123,
StackSetFailureTolerancePercentage = 123,
StackSetMaxConcurrencyCount = 123,
StackSetMaxConcurrencyPercentage = 123,
StackSetOperationType = "stackSetOperationType",
StackSetRegions = new [] { "stackSetRegions" }
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnCloudFormationProvisionedProduct(Construct, String, ICfnCloudFormationProvisionedProductProps) | Create a new |
CfnCloudFormationProvisionedProduct(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnCloudFormationProvisionedProduct(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AcceptLanguage | The language code. |
AttrCloudformationStackArn | The Amazon Resource Name (ARN) of the CloudFormation stack, such as |
AttrOutputs | The output of the product you are provisioning. |
AttrProvisionedProductId | The ID of the provisioned product. |
AttrRecordId | The ID of the record, such as |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
NotificationArns | Passed to AWS CloudFormation . |
PathId | The path identifier of the product. |
PathName | The name of the path. |
ProductId | The product identifier. |
ProductName | The name of the Service Catalog product. |
ProvisionedProductName | A user-friendly name for the provisioned product. |
ProvisioningArtifactId | The identifier of the provisioning artifact (also known as a version). |
ProvisioningArtifactName | The name of the provisioning artifact (also known as a version) for the product. |
ProvisioningParameters | Parameters specified by the administrator that are required for provisioning the product. |
ProvisioningPreferences | StackSet preferences that are required for provisioning the product or updating a provisioned product. |
Tags | One or more tags. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnCloudFormationProvisionedProduct(Construct, String, ICfnCloudFormationProvisionedProductProps)
Create a new AWS::ServiceCatalog::CloudFormationProvisionedProduct
.
public CfnCloudFormationProvisionedProduct(Construct scope, string id, ICfnCloudFormationProvisionedProductProps props = null)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnCloudFormationProvisionedProductProps
- resource properties.
CfnCloudFormationProvisionedProduct(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnCloudFormationProvisionedProduct(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnCloudFormationProvisionedProduct(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnCloudFormationProvisionedProduct(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AcceptLanguage
The language code.
public virtual string AcceptLanguage { get; set; }
Property Value
System.String
Remarks
AttrCloudformationStackArn
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
.
public virtual string AttrCloudformationStackArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CloudformationStackArn
AttrOutputs
The output of the product you are provisioning.
public virtual IResolvable AttrOutputs { get; }
Property Value
Remarks
For example, the DNS of an EC2 instance.
CloudformationAttribute: Outputs
AttrProvisionedProductId
The ID of the provisioned product.
public virtual string AttrProvisionedProductId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ProvisionedProductId
AttrRecordId
The ID of the record, such as rec-rjeatvy434trk
.
public virtual string AttrRecordId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: RecordId
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
NotificationArns
Passed to AWS CloudFormation .
public virtual string[] NotificationArns { get; set; }
Property Value
System.String[]
Remarks
The SNS topic ARNs to which to publish stack-related events.
PathId
The path identifier of the product.
public virtual string PathId { get; set; }
Property Value
System.String
Remarks
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.
PathName
The name of the path.
public virtual string PathName { get; set; }
Property Value
System.String
Remarks
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.
ProductId
The product identifier.
public virtual string ProductId { get; set; }
Property Value
System.String
Remarks
You must specify either the ID or the name of the product, but not both.
ProductName
The name of the Service Catalog product.
public virtual string ProductName { get; set; }
Property Value
System.String
Remarks
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.
ProvisionedProductName
A user-friendly name for the provisioned product.
public virtual string ProvisionedProductName { get; set; }
Property Value
System.String
Remarks
This value must be unique for the AWS account and cannot be updated after the product is provisioned.
ProvisioningArtifactId
The identifier of the provisioning artifact (also known as a version).
public virtual string ProvisioningArtifactId { get; set; }
Property Value
System.String
Remarks
You must specify either the ID or the name of the provisioning artifact, but not both.
ProvisioningArtifactName
The name of the provisioning artifact (also known as a version) for the product.
public virtual string ProvisioningArtifactName { get; set; }
Property Value
System.String
Remarks
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.
ProvisioningParameters
Parameters specified by the administrator that are required for provisioning the product.
public virtual object ProvisioningParameters { get; set; }
Property Value
System.Object
Remarks
ProvisioningPreferences
StackSet preferences that are required for provisioning the product or updating a provisioned product.
public virtual object ProvisioningPreferences { get; set; }
Property Value
System.Object
Remarks
Tags
One or more tags.
public virtual TagManager Tags { get; }
Property Value
Remarks
Requires the provisioned product to have an ResourceUpdateConstraint resource with TagUpdatesOnProvisionedProduct
set to ALLOWED
to allow tag updates. If RESOURCE_UPDATE
constraint is not present, tags updates are ignored.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>