Class ProvisioningArtifact


  • public class ProvisioningArtifact
    extends com.pulumi.resources.CustomResource
    Manages a Service Catalog Provisioning Artifact for a specified product. > A "provisioning artifact" is also referred to as a "version." > **NOTE:** You cannot create a provisioning artifact for a product that was shared with you. > **NOTE:** The user or role that use this resource must have the `cloudformation:GetTemplate` IAM policy permission. This policy permission is required when using the `template_physical_id` argument. ## Example Usage ### Basic Usage <!--Start PulumiCodeChooser -->
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.servicecatalog.ProvisioningArtifact;
     import com.pulumi.aws.servicecatalog.ProvisioningArtifactArgs;
     import java.util.List;
     import java.util.ArrayList;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var example = new ProvisioningArtifact("example", ProvisioningArtifactArgs.builder()
                 .name("example")
                 .productId(exampleAwsServicecatalogProduct.id())
                 .type("CLOUD_FORMATION_TEMPLATE")
                 .templateUrl(String.format("https://%s/%s", exampleAwsS3Bucket.bucketRegionalDomainName(),exampleAwsS3Object.key()))
                 .build());
     
         }
     }
     
     
    <!--End PulumiCodeChooser --> ## Import Using `pulumi import`, import `aws_servicecatalog_provisioning_artifact` using the provisioning artifact ID and product ID separated by a colon. For example: ```sh $ pulumi import aws:servicecatalog/provisioningArtifact:ProvisioningArtifact example pa-ij2b6lusy6dec:prod-el3an0rma3 ```
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> acceptLanguage()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> active()  
      com.pulumi.core.Output<java.lang.String> createdTime()  
      com.pulumi.core.Output<java.lang.String> description()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> disableTemplateValidation()  
      static ProvisioningArtifact get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ProvisioningArtifactState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> guidance()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> productId()  
      com.pulumi.core.Output<java.lang.String> provisioningArtifactId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> templatePhysicalId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> templateUrl()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> type()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ProvisioningArtifact

        public ProvisioningArtifact​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • ProvisioningArtifact

        public ProvisioningArtifact​(java.lang.String name,
                                    ProvisioningArtifactArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • ProvisioningArtifact

        public ProvisioningArtifact​(java.lang.String name,
                                    ProvisioningArtifactArgs args,
                                    @Nullable
                                    com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • acceptLanguage

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> acceptLanguage()
        Returns:
        Language code. Valid values: `en` (English), `jp` (Japanese), `zh` (Chinese). The default value is `en`.
      • active

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> active()
        Returns:
        Whether the product version is active. Inactive provisioning artifacts are invisible to end users. End users cannot launch or update a provisioned product from an inactive provisioning artifact. Default is `true`.
      • createdTime

        public com.pulumi.core.Output<java.lang.String> createdTime()
        Returns:
        Time when the provisioning artifact was created.
      • description

        public com.pulumi.core.Output<java.lang.String> description()
        Returns:
        Description of the provisioning artifact (i.e., version), including how it differs from the previous provisioning artifact.
      • disableTemplateValidation

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> disableTemplateValidation()
        Returns:
        Whether AWS Service Catalog stops validating the specified provisioning artifact template even if it is invalid.
      • guidance

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> guidance()
        Returns:
        Information set by the administrator to provide guidance to end users about which provisioning artifacts to use. Valid values are `DEFAULT` and `DEPRECATED`. The default is `DEFAULT`. Users are able to make updates to a provisioned product of a deprecated version but cannot launch new provisioned products using a deprecated version.
      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the provisioning artifact (for example, `v1`, `v2beta`). No spaces are allowed.
      • productId

        public com.pulumi.core.Output<java.lang.String> productId()
        Returns:
        Identifier of the product.
      • provisioningArtifactId

        public com.pulumi.core.Output<java.lang.String> provisioningArtifactId()
        Returns:
        Provisioning artifact identifier.
      • templatePhysicalId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> templatePhysicalId()
        Returns:
        Template source as the physical ID of the resource that contains the template. Currently only supports CloudFormation stack ARN. Specify the physical ID as `arn:[partition]:cloudformation:[region]:[account ID]:stack/[stack name]/[resource ID]`.
      • templateUrl

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> templateUrl()
        Returns:
        Template source as URL of the CloudFormation template in Amazon S3. The following arguments are optional:
      • type

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> type()
        Returns:
        Type of provisioning artifact. See [AWS Docs](https://docs.aws.amazon.com/servicecatalog/latest/dg/API_ProvisioningArtifactProperties.html) for valid list of values.
      • get

        public static ProvisioningArtifact get​(java.lang.String name,
                                               com.pulumi.core.Output<java.lang.String> id,
                                               @Nullable
                                               ProvisioningArtifactState state,
                                               @Nullable
                                               com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.