Class CfnCloudFormationProduct
A CloudFormation AWS::ServiceCatalog::CloudFormationProduct
.
Inherited Members
Namespace: Amazon.CDK.AWS.ServiceCatalog
Assembly: Amazon.CDK.AWS.ServiceCatalog.dll
Syntax (csharp)
public class CfnCloudFormationProduct : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnCloudFormationProduct
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Specifies a product.
CloudformationResource: AWS::ServiceCatalog::CloudFormationProduct
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 info;
var cfnCloudFormationProduct = new CfnCloudFormationProduct(this, "MyCfnCloudFormationProduct", new CfnCloudFormationProductProps {
Name = "name",
Owner = "owner",
// the properties below are optional
AcceptLanguage = "acceptLanguage",
Description = "description",
Distributor = "distributor",
ProductType = "productType",
ProvisioningArtifactParameters = new [] { new ProvisioningArtifactPropertiesProperty {
Info = info,
// the properties below are optional
Description = "description",
DisableTemplateValidation = false,
Name = "name",
Type = "type"
} },
ReplaceProvisioningArtifacts = false,
SourceConnection = new SourceConnectionProperty {
ConnectionParameters = new ConnectionParametersProperty {
CodeStar = new CodeStarParametersProperty {
ArtifactPath = "artifactPath",
Branch = "branch",
ConnectionArn = "connectionArn",
Repository = "repository"
}
},
Type = "type"
},
SupportDescription = "supportDescription",
SupportEmail = "supportEmail",
SupportUrl = "supportUrl",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnCloudFormationProduct(Construct, String, ICfnCloudFormationProductProps) | Create a new |
CfnCloudFormationProduct(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnCloudFormationProduct(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AcceptLanguage | The language code. |
AttrProductName | The name of the product. |
AttrProvisioningArtifactIds | The IDs of the provisioning artifacts. |
AttrProvisioningArtifactNames | The names of the provisioning artifacts. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | The description of the product. |
Distributor | The distributor of the product. |
Name | The name of the product. |
Owner | The owner of the product. |
ProductType | The type of product. |
ProvisioningArtifactParameters | The configuration of the provisioning artifact (also known as a version). |
ReplaceProvisioningArtifacts | This property is turned off by default. |
SourceConnection | A top level |
SupportDescription | The support information about the product. |
SupportEmail | The contact email for product support. |
SupportUrl | The contact URL for product support. |
Tags | One or more tags. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnCloudFormationProduct(Construct, String, ICfnCloudFormationProductProps)
Create a new AWS::ServiceCatalog::CloudFormationProduct
.
public CfnCloudFormationProduct(Construct scope, string id, ICfnCloudFormationProductProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnCloudFormationProductProps
- resource properties.
CfnCloudFormationProduct(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnCloudFormationProduct(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnCloudFormationProduct(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnCloudFormationProduct(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
AttrProductName
The name of the product.
public virtual string AttrProductName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ProductName
AttrProvisioningArtifactIds
The IDs of the provisioning artifacts.
public virtual string AttrProvisioningArtifactIds { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ProvisioningArtifactIds
AttrProvisioningArtifactNames
The names of the provisioning artifacts.
public virtual string AttrProvisioningArtifactNames { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ProvisioningArtifactNames
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
Description
The description of the product.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
Distributor
The distributor of the product.
public virtual string Distributor { get; set; }
Property Value
System.String
Remarks
Name
The name of the product.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Owner
The owner of the product.
public virtual string Owner { get; set; }
Property Value
System.String
Remarks
ProductType
The type of product.
public virtual string ProductType { get; set; }
Property Value
System.String
Remarks
ProvisioningArtifactParameters
The configuration of the provisioning artifact (also known as a version).
public virtual object ProvisioningArtifactParameters { get; set; }
Property Value
System.Object
Remarks
ReplaceProvisioningArtifacts
This property is turned off by default.
public virtual object ReplaceProvisioningArtifacts { get; set; }
Property Value
System.Object
Remarks
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.
SourceConnection
A top level ProductViewDetail
response containing details about the product’s connection.
public virtual object SourceConnection { get; set; }
Property Value
System.Object
Remarks
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.
SupportDescription
The support information about the product.
public virtual string SupportDescription { get; set; }
Property Value
System.String
Remarks
SupportEmail
The contact email for product support.
public virtual string SupportEmail { get; set; }
Property Value
System.String
Remarks
SupportUrl
The contact URL for product support.
public virtual string SupportUrl { get; set; }
Property Value
System.String
Remarks
^https?:///
/ is the pattern used to validate SupportUrl.
Tags
One or more tags.
public virtual TagManager Tags { get; }
Property Value
Remarks
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>