1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. servicecatalog
  5. getCloudFormationProduct

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.46.0 published on Monday, Dec 29, 2025 by Pulumi
aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.46.0 published on Monday, Dec 29, 2025 by Pulumi

    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 dictionary

    The following arguments are supported:

    Id string
    Id string
    id String
    id string
    id str
    id String

    getCloudFormationProduct Result

    The following output properties are available:

    AcceptLanguage string
    The language code.

    • jp - Japanese
    • zh - 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.
    ProductName string
    The name of the product.
    ProductType string
    The type of product.
    ProvisioningArtifactIds string
    The IDs of the provisioning artifacts.
    ProvisioningArtifactNames string
    The names of the provisioning artifacts.
    ProvisioningArtifactParameters List<Pulumi.AwsNative.ServiceCatalog.Outputs.CloudFormationProductProvisioningArtifactProperties>
    The configuration of the provisioning artifact (also known as a version).
    ReplaceProvisioningArtifacts bool

    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.

    SourceConnection Pulumi.AwsNative.ServiceCatalog.Outputs.CloudFormationProductSourceConnection
    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.
    SupportDescription string
    The support information about the product.
    SupportEmail string
    The contact email for product support.
    SupportUrl string

    The contact URL for product support.

    ^https?:\/\// / is the pattern used to validate SupportUrl.

    Tags List<Pulumi.AwsNative.Outputs.Tag>
    One or more tags.
    AcceptLanguage string
    The language code.

    • jp - Japanese
    • zh - 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.
    ProductName string
    The name of the product.
    ProductType string
    The type of product.
    ProvisioningArtifactIds string
    The IDs of the provisioning artifacts.
    ProvisioningArtifactNames string
    The names of the provisioning artifacts.
    ProvisioningArtifactParameters []CloudFormationProductProvisioningArtifactProperties
    The configuration of the provisioning artifact (also known as a version).
    ReplaceProvisioningArtifacts bool

    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.

    SourceConnection CloudFormationProductSourceConnection
    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.
    SupportDescription string
    The support information about the product.
    SupportEmail string
    The contact email for product support.
    SupportUrl string

    The contact URL for product support.

    ^https?:\/\// / is the pattern used to validate SupportUrl.

    Tags Tag
    One or more tags.
    acceptLanguage String
    The language code.

    • jp - Japanese
    • zh - 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.
    productName String
    The name of the product.
    productType String
    The type of product.
    provisioningArtifactIds String
    The IDs of the provisioning artifacts.
    provisioningArtifactNames String
    The names of the provisioning artifacts.
    provisioningArtifactParameters List<CloudFormationProductProvisioningArtifactProperties>
    The configuration of the provisioning artifact (also known as a version).
    replaceProvisioningArtifacts Boolean

    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.

    sourceConnection CloudFormationProductSourceConnection
    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.
    supportDescription String
    The support information about the product.
    supportEmail String
    The contact email for product support.
    supportUrl String

    The contact URL for product support.

    ^https?:\/\// / is the pattern used to validate SupportUrl.

    tags List<Tag>
    One or more tags.
    acceptLanguage string
    The language code.

    • jp - Japanese
    • zh - 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.
    productName string
    The name of the product.
    productType string
    The type of product.
    provisioningArtifactIds string
    The IDs of the provisioning artifacts.
    provisioningArtifactNames string
    The names of the provisioning artifacts.
    provisioningArtifactParameters CloudFormationProductProvisioningArtifactProperties[]
    The configuration of the provisioning artifact (also known as a version).
    replaceProvisioningArtifacts boolean

    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.

    sourceConnection CloudFormationProductSourceConnection
    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.
    supportDescription string
    The support information about the product.
    supportEmail string
    The contact email for product support.
    supportUrl string

    The contact URL for product support.

    ^https?:\/\// / is the pattern used to validate SupportUrl.

    tags Tag[]
    One or more tags.
    accept_language str
    The language code.

    • jp - Japanese
    • zh - 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_ids str
    The IDs of the provisioning artifacts.
    provisioning_artifact_names str
    The names of the provisioning artifacts.
    provisioning_artifact_parameters Sequence[CloudFormationProductProvisioningArtifactProperties]
    The configuration of the provisioning artifact (also known as a version).
    replace_provisioning_artifacts bool

    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 CloudFormationProductSourceConnection
    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.
    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.

    tags Sequence[root_Tag]
    One or more tags.
    acceptLanguage String
    The language code.

    • jp - Japanese
    • zh - 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.
    productName String
    The name of the product.
    productType String
    The type of product.
    provisioningArtifactIds String
    The IDs of the provisioning artifacts.
    provisioningArtifactNames String
    The names of the provisioning artifacts.
    provisioningArtifactParameters List<Property Map>
    The configuration of the provisioning artifact (also known as a version).
    replaceProvisioningArtifacts Boolean

    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.

    sourceConnection Property Map
    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.
    supportDescription String
    The support information about the product.
    supportEmail String
    The contact email for product support.
    supportUrl String

    The contact URL for product support.

    ^https?:\/\// / is the pattern used to validate SupportUrl.

    tags List<Property Map>
    One or more tags.

    Supporting Types

    CloudFormationProductCodeStarParameters

    ArtifactPath 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.
    ConnectionArn 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."
    ArtifactPath 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.
    ConnectionArn 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."
    artifactPath 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.
    connectionArn 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."
    artifactPath 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.
    connectionArn 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."
    artifactPath 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.
    connectionArn 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

    CodeStar CloudFormationProductCodeStarParameters
    Provides ConnectionType details.
    codeStar CloudFormationProductCodeStarParameters
    Provides ConnectionType details.
    codeStar CloudFormationProductCodeStarParameters
    Provides ConnectionType details.
    code_star CloudFormationProductCodeStarParameters
    Provides ConnectionType details.
    codeStar Property Map
    Provides ConnectionType details.

    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.
    DisableTemplateValidation bool
    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 template
    • TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file
    • TERRAFORM_CLOUD - Terraform Cloud configuration file
    • EXTERNAL - 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.
    DisableTemplateValidation bool
    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 template
    • TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file
    • TERRAFORM_CLOUD - Terraform Cloud configuration file
    • EXTERNAL - 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.
    disableTemplateValidation Boolean
    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 template
    • TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file
    • TERRAFORM_CLOUD - Terraform Cloud configuration file
    • EXTERNAL - 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.
    disableTemplateValidation boolean
    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 template
    • TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file
    • TERRAFORM_CLOUD - Terraform Cloud configuration file
    • EXTERNAL - 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_validation bool
    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 template
    • TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file
    • TERRAFORM_CLOUD - Terraform Cloud configuration file
    • EXTERNAL - 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.
    disableTemplateValidation Boolean
    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 template
    • TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file
    • TERRAFORM_CLOUD - Terraform Cloud configuration file
    • EXTERNAL - External configuration file

    CloudFormationProductSourceConnection

    ConnectionParameters Pulumi.AwsNative.ServiceCatalog.Inputs.CloudFormationProductConnectionParameters
    The connection details based on the connection Type .
    Type string
    The only supported SourceConnection type is Codestar.
    ConnectionParameters CloudFormationProductConnectionParameters
    The connection details based on the connection Type .
    Type string
    The only supported SourceConnection type is Codestar.
    connectionParameters CloudFormationProductConnectionParameters
    The connection details based on the connection Type .
    type String
    The only supported SourceConnection type is Codestar.
    connectionParameters CloudFormationProductConnectionParameters
    The connection details based on the connection Type .
    type string
    The only supported SourceConnection type is Codestar.
    connection_parameters CloudFormationProductConnectionParameters
    The connection details based on the connection Type .
    type str
    The only supported SourceConnection type is Codestar.
    connectionParameters Property Map
    The connection details based on the connection Type .
    type String
    The only supported SourceConnection type is Codestar.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.46.0 published on Monday, Dec 29, 2025 by Pulumi
      Meet Neo: Your AI Platform Teammate