We recommend new projects start with resources from the AWS provider.
We recommend new projects start with resources from the AWS provider.
Resource Type definition for AWS::ServiceCatalog::CloudFormationProduct
Using getCloudFormationProduct
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getCloudFormationProduct(args: GetCloudFormationProductArgs, opts?: InvokeOptions): Promise<GetCloudFormationProductResult>
function getCloudFormationProductOutput(args: GetCloudFormationProductOutputArgs, opts?: InvokeOptions): Output<GetCloudFormationProductResult>def get_cloud_formation_product(id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetCloudFormationProductResult
def get_cloud_formation_product_output(id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetCloudFormationProductResult]func LookupCloudFormationProduct(ctx *Context, args *LookupCloudFormationProductArgs, opts ...InvokeOption) (*LookupCloudFormationProductResult, error)
func LookupCloudFormationProductOutput(ctx *Context, args *LookupCloudFormationProductOutputArgs, opts ...InvokeOption) LookupCloudFormationProductResultOutput> Note: This function is named LookupCloudFormationProduct in the Go SDK.
public static class GetCloudFormationProduct
{
public static Task<GetCloudFormationProductResult> InvokeAsync(GetCloudFormationProductArgs args, InvokeOptions? opts = null)
public static Output<GetCloudFormationProductResult> Invoke(GetCloudFormationProductInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetCloudFormationProductResult> getCloudFormationProduct(GetCloudFormationProductArgs args, InvokeOptions options)
public static Output<GetCloudFormationProductResult> getCloudFormationProduct(GetCloudFormationProductArgs args, InvokeOptions options)
fn::invoke:
function: aws-native:servicecatalog:getCloudFormationProduct
arguments:
# arguments dictionaryThe following arguments are supported:
- Id string
- Id string
- id String
- id string
- id str
- id String
getCloudFormationProduct Result
The following output properties are available:
- Accept
Language string - The language code.
jp- Japanesezh- Chinese
- Description string
- The description of the product.
- Distributor string
- The distributor of the product.
- Id string
- Name string
- The name of the product.
- Owner string
- The owner of the product.
- Product
Name string - The name of the product.
- Product
Type string - The type of product.
- Provisioning
Artifact stringIds - The IDs of the provisioning artifacts.
- Provisioning
Artifact stringNames - The names of the provisioning artifacts.
- Provisioning
Artifact List<Pulumi.Parameters Aws Native. Service Catalog. Outputs. Cloud Formation Product Provisioning Artifact Properties> - The configuration of the provisioning artifact (also known as a version).
- Replace
Provisioning boolArtifacts 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.
- Source
Connection Pulumi.Aws Native. Service Catalog. Outputs. Cloud Formation Product Source Connection - A top level
ProductViewDetailresponse containing details about the product’s connection. AWS Service Catalog returns this field for theCreateProduct,UpdateProduct,DescribeProductAsAdmin, andSearchProductAsAdminAPIs. This response contains the same fields as theConnectionParametersrequest, with the addition of theLastSyncresponse. - Support
Description string - The support information about the product.
- Support
Email string - The contact email for product support.
- Support
Url string The contact URL for product support.
^https?:\/\/// is the pattern used to validate SupportUrl.-
List<Pulumi.
Aws Native. Outputs. Tag> - One or more tags.
- Accept
Language string - The language code.
jp- Japanesezh- Chinese
- Description string
- The description of the product.
- Distributor string
- The distributor of the product.
- Id string
- Name string
- The name of the product.
- Owner string
- The owner of the product.
- Product
Name string - The name of the product.
- Product
Type string - The type of product.
- Provisioning
Artifact stringIds - The IDs of the provisioning artifacts.
- Provisioning
Artifact stringNames - The names of the provisioning artifacts.
- Provisioning
Artifact []CloudParameters Formation Product Provisioning Artifact Properties - The configuration of the provisioning artifact (also known as a version).
- Replace
Provisioning boolArtifacts 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.
- Source
Connection CloudFormation Product Source Connection - A top level
ProductViewDetailresponse containing details about the product’s connection. AWS Service Catalog returns this field for theCreateProduct,UpdateProduct,DescribeProductAsAdmin, andSearchProductAsAdminAPIs. This response contains the same fields as theConnectionParametersrequest, with the addition of theLastSyncresponse. - Support
Description string - The support information about the product.
- Support
Email string - The contact email for product support.
- Support
Url string The contact URL for product support.
^https?:\/\/// is the pattern used to validate SupportUrl.- Tag
- One or more tags.
- accept
Language String - The language code.
jp- Japanesezh- Chinese
- description String
- The description of the product.
- distributor String
- The distributor of the product.
- id String
- name String
- The name of the product.
- owner String
- The owner of the product.
- product
Name String - The name of the product.
- product
Type String - The type of product.
- provisioning
Artifact StringIds - The IDs of the provisioning artifacts.
- provisioning
Artifact StringNames - The names of the provisioning artifacts.
- provisioning
Artifact List<CloudParameters Formation Product Provisioning Artifact Properties> - The configuration of the provisioning artifact (also known as a version).
- replace
Provisioning BooleanArtifacts 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.
- source
Connection CloudFormation Product Source Connection - A top level
ProductViewDetailresponse containing details about the product’s connection. AWS Service Catalog returns this field for theCreateProduct,UpdateProduct,DescribeProductAsAdmin, andSearchProductAsAdminAPIs. This response contains the same fields as theConnectionParametersrequest, with the addition of theLastSyncresponse. - support
Description String - The support information about the product.
- support
Email String - The contact email for product support.
- support
Url String The contact URL for product support.
^https?:\/\/// is the pattern used to validate SupportUrl.- List<Tag>
- One or more tags.
- accept
Language string - The language code.
jp- Japanesezh- Chinese
- description string
- The description of the product.
- distributor string
- The distributor of the product.
- id string
- name string
- The name of the product.
- owner string
- The owner of the product.
- product
Name string - The name of the product.
- product
Type string - The type of product.
- provisioning
Artifact stringIds - The IDs of the provisioning artifacts.
- provisioning
Artifact stringNames - The names of the provisioning artifacts.
- provisioning
Artifact CloudParameters Formation Product Provisioning Artifact Properties[] - The configuration of the provisioning artifact (also known as a version).
- replace
Provisioning booleanArtifacts 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.
- source
Connection CloudFormation Product Source Connection - A top level
ProductViewDetailresponse containing details about the product’s connection. AWS Service Catalog returns this field for theCreateProduct,UpdateProduct,DescribeProductAsAdmin, andSearchProductAsAdminAPIs. This response contains the same fields as theConnectionParametersrequest, with the addition of theLastSyncresponse. - support
Description string - The support information about the product.
- support
Email string - The contact email for product support.
- support
Url string The contact URL for product support.
^https?:\/\/// is the pattern used to validate SupportUrl.- Tag[]
- One or more tags.
- accept_
language str - The language code.
jp- Japanesezh- Chinese
- description str
- The description of the product.
- distributor str
- The distributor of the product.
- id str
- name str
- The name of the product.
- owner str
- The owner of the product.
- product_
name str - The name of the product.
- product_
type str - The type of product.
- provisioning_
artifact_ strids - The IDs of the provisioning artifacts.
- provisioning_
artifact_ strnames - The names of the provisioning artifacts.
- provisioning_
artifact_ Sequence[Cloudparameters Formation Product Provisioning Artifact Properties] - The configuration of the provisioning artifact (also known as a version).
- replace_
provisioning_ boolartifacts 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.
- source_
connection CloudFormation Product Source Connection - A top level
ProductViewDetailresponse containing details about the product’s connection. AWS Service Catalog returns this field for theCreateProduct,UpdateProduct,DescribeProductAsAdmin, andSearchProductAsAdminAPIs. This response contains the same fields as theConnectionParametersrequest, with the addition of theLastSyncresponse. - support_
description str - The support information about the product.
- support_
email str - The contact email for product support.
- support_
url str The contact URL for product support.
^https?:\/\/// is the pattern used to validate SupportUrl.- Sequence[root_Tag]
- One or more tags.
- accept
Language String - The language code.
jp- Japanesezh- Chinese
- description String
- The description of the product.
- distributor String
- The distributor of the product.
- id String
- name String
- The name of the product.
- owner String
- The owner of the product.
- product
Name String - The name of the product.
- product
Type String - The type of product.
- provisioning
Artifact StringIds - The IDs of the provisioning artifacts.
- provisioning
Artifact StringNames - The names of the provisioning artifacts.
- provisioning
Artifact List<Property Map>Parameters - The configuration of the provisioning artifact (also known as a version).
- replace
Provisioning BooleanArtifacts 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.
- source
Connection Property Map - A top level
ProductViewDetailresponse containing details about the product’s connection. AWS Service Catalog returns this field for theCreateProduct,UpdateProduct,DescribeProductAsAdmin, andSearchProductAsAdminAPIs. This response contains the same fields as theConnectionParametersrequest, with the addition of theLastSyncresponse. - support
Description String - The support information about the product.
- support
Email String - The contact email for product support.
- support
Url String The contact URL for product support.
^https?:\/\/// is the pattern used to validate SupportUrl.- List<Property Map>
- One or more tags.
Supporting Types
CloudFormationProductCodeStarParameters
- Artifact
Path string - The absolute path wehre the artifact resides within the repo and branch, formatted as "folder/file.json."
- Branch string
- The specific branch where the artifact resides.
- Connection
Arn string - The CodeStar ARN, which is the connection between AWS Service Catalog and the external repository.
- Repository string
- The specific repository where the product’s artifact-to-be-synced resides, formatted as "Account/Repo."
- Artifact
Path string - The absolute path wehre the artifact resides within the repo and branch, formatted as "folder/file.json."
- Branch string
- The specific branch where the artifact resides.
- Connection
Arn string - The CodeStar ARN, which is the connection between AWS Service Catalog and the external repository.
- Repository string
- The specific repository where the product’s artifact-to-be-synced resides, formatted as "Account/Repo."
- artifact
Path String - The absolute path wehre the artifact resides within the repo and branch, formatted as "folder/file.json."
- branch String
- The specific branch where the artifact resides.
- connection
Arn String - The CodeStar ARN, which is the connection between AWS Service Catalog and the external repository.
- repository String
- The specific repository where the product’s artifact-to-be-synced resides, formatted as "Account/Repo."
- artifact
Path string - The absolute path wehre the artifact resides within the repo and branch, formatted as "folder/file.json."
- branch string
- The specific branch where the artifact resides.
- connection
Arn string - The CodeStar ARN, which is the connection between AWS Service Catalog and the external repository.
- repository string
- The specific repository where the product’s artifact-to-be-synced resides, formatted as "Account/Repo."
- artifact_
path str - The absolute path wehre the artifact resides within the repo and branch, formatted as "folder/file.json."
- branch str
- The specific branch where the artifact resides.
- connection_
arn str - The CodeStar ARN, which is the connection between AWS Service Catalog and the external repository.
- repository str
- The specific repository where the product’s artifact-to-be-synced resides, formatted as "Account/Repo."
- artifact
Path String - The absolute path wehre the artifact resides within the repo and branch, formatted as "folder/file.json."
- branch String
- The specific branch where the artifact resides.
- connection
Arn String - The CodeStar ARN, which is the connection between AWS Service Catalog and the external repository.
- repository String
- The specific repository where the product’s artifact-to-be-synced resides, formatted as "Account/Repo."
CloudFormationProductConnectionParameters
- Code
Star Pulumi.Aws Native. Service Catalog. Inputs. Cloud Formation Product Code Star Parameters - Provides
ConnectionTypedetails.
- Code
Star CloudFormation Product Code Star Parameters - Provides
ConnectionTypedetails.
- code
Star CloudFormation Product Code Star Parameters - Provides
ConnectionTypedetails.
- code
Star CloudFormation Product Code Star Parameters - Provides
ConnectionTypedetails.
- code_
star CloudFormation Product Code Star Parameters - Provides
ConnectionTypedetails.
- code
Star Property Map - Provides
ConnectionTypedetails.
CloudFormationProductProvisioningArtifactProperties
- Info object
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]- Description string
- The description of the provisioning artifact, including how it differs from the previous provisioning artifact.
- Disable
Template boolValidation - If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid.
- Name string
- The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.
- Type string
- The type of provisioning artifact.
CLOUD_FORMATION_TEMPLATE- AWS CloudFormation templateTERRAFORM_OPEN_SOURCE- Terraform Open Source configuration fileTERRAFORM_CLOUD- Terraform Cloud configuration fileEXTERNAL- External configuration file
- Info interface{}
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]- Description string
- The description of the provisioning artifact, including how it differs from the previous provisioning artifact.
- Disable
Template boolValidation - If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid.
- Name string
- The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.
- Type string
- The type of provisioning artifact.
CLOUD_FORMATION_TEMPLATE- AWS CloudFormation templateTERRAFORM_OPEN_SOURCE- Terraform Open Source configuration fileTERRAFORM_CLOUD- Terraform Cloud configuration fileEXTERNAL- External configuration file
- info Object
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]- description String
- The description of the provisioning artifact, including how it differs from the previous provisioning artifact.
- disable
Template BooleanValidation - If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid.
- name String
- The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.
- type String
- The type of provisioning artifact.
CLOUD_FORMATION_TEMPLATE- AWS CloudFormation templateTERRAFORM_OPEN_SOURCE- Terraform Open Source configuration fileTERRAFORM_CLOUD- Terraform Cloud configuration fileEXTERNAL- External configuration file
- info any
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]- description string
- The description of the provisioning artifact, including how it differs from the previous provisioning artifact.
- disable
Template booleanValidation - If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid.
- name string
- The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.
- type string
- The type of provisioning artifact.
CLOUD_FORMATION_TEMPLATE- AWS CloudFormation templateTERRAFORM_OPEN_SOURCE- Terraform Open Source configuration fileTERRAFORM_CLOUD- Terraform Cloud configuration fileEXTERNAL- External configuration file
- info Any
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]- description str
- The description of the provisioning artifact, including how it differs from the previous provisioning artifact.
- disable_
template_ boolvalidation - If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid.
- name str
- The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.
- type str
- The type of provisioning artifact.
CLOUD_FORMATION_TEMPLATE- AWS CloudFormation templateTERRAFORM_OPEN_SOURCE- Terraform Open Source configuration fileTERRAFORM_CLOUD- Terraform Cloud configuration fileEXTERNAL- External configuration file
- info Any
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]- description String
- The description of the provisioning artifact, including how it differs from the previous provisioning artifact.
- disable
Template BooleanValidation - If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid.
- name String
- The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.
- type String
- The type of provisioning artifact.
CLOUD_FORMATION_TEMPLATE- AWS CloudFormation templateTERRAFORM_OPEN_SOURCE- Terraform Open Source configuration fileTERRAFORM_CLOUD- Terraform Cloud configuration fileEXTERNAL- External configuration file
CloudFormationProductSourceConnection
- Connection
Parameters Pulumi.Aws Native. Service Catalog. Inputs. Cloud Formation Product Connection Parameters - The connection details based on the connection
Type. - Type string
- The only supported
SourceConnectiontype is Codestar.
- Connection
Parameters CloudFormation Product Connection Parameters - The connection details based on the connection
Type. - Type string
- The only supported
SourceConnectiontype is Codestar.
- connection
Parameters CloudFormation Product Connection Parameters - The connection details based on the connection
Type. - type String
- The only supported
SourceConnectiontype is Codestar.
- connection
Parameters CloudFormation Product Connection Parameters - The connection details based on the connection
Type. - type string
- The only supported
SourceConnectiontype is Codestar.
- connection_
parameters CloudFormation Product Connection Parameters - The connection details based on the connection
Type. - type str
- The only supported
SourceConnectiontype is Codestar.
- connection
Parameters Property Map - The connection details based on the connection
Type. - type String
- The only supported
SourceConnectiontype is Codestar.
Tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
