Package com.pulumi.aws.imagebuilder

Class Component

  • public class Component
extends com.pulumi.resources.CustomResource
    Manages an Image Builder Component. ## Example Usage ### URI Document 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.imagebuilder.Component;
 import com.pulumi.aws.imagebuilder.ComponentArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 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 Component("example", ComponentArgs.builder()
             .name("example")
             .platform("Linux")
             .uri(String.format("s3://%s/%s", exampleAwsS3Object.bucket(),exampleAwsS3Object.key()))
             .version("1.0.0")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import `aws.imagebuilder.getComponents` resources using the ARN. For example: ```sh $ pulumi import aws:imagebuilder/component:Component example arn:aws:imagebuilder:us-east-1:123456789012:component/example/1.0.0/1 ``` Certain resource arguments, such as `uri`, cannot be read via the API and imported into the provider. The provider will display a difference for these arguments the first run after import if declared in the the provider configuration for an imported resource.

    • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      Component​(java.lang.String name)  
      Component​(java.lang.String name, ComponentArgs args)  
      Component​(java.lang.String name, ComponentArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> changeDescription()  
      com.pulumi.core.Output<java.lang.String> data()  
      com.pulumi.core.Output<java.lang.String> dateCreated()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.lang.Boolean> encrypted()  
      static Component get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ComponentState 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>> kmsKeyId()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> owner()  
      com.pulumi.core.Output<java.lang.String> platform()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> skipDestroy()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> supportedOsVersions()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.String> type()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> uri()  
      com.pulumi.core.Output<java.lang.String> version()  

      • 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

      • Component

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

      • Component

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

      • Component

        public Component​(java.lang.String name,
                 ComponentArgs 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

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        (Required) ARN of the component.

      • changeDescription

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> changeDescription()
        Returns:
        Change description of the component.

      • data

        public com.pulumi.core.Output<java.lang.String> data()
        Returns:
        Inline YAML string with data of the component. Exactly one of `data` and `uri` can be specified. the provider will only perform drift detection of its value when present in a configuration.

      • dateCreated

        public com.pulumi.core.Output<java.lang.String> dateCreated()
        Returns:
        Date the component was created.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description of the component.

      • encrypted

        public com.pulumi.core.Output<java.lang.Boolean> encrypted()
        Returns:
        Encryption status of the component.

      • kmsKeyId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> kmsKeyId()
        Returns:
        ARN of the KMS Key used to encrypt the component.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the component.

      • owner

        public com.pulumi.core.Output<java.lang.String> owner()
        Returns:
        Owner of the component.

      • platform

        public com.pulumi.core.Output<java.lang.String> platform()
        Returns:
        Platform of the component.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • skipDestroy

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> skipDestroy()
        Returns:
        Whether to retain the old version when the resource is destroyed or replacement is necessary. Defaults to `false`.

      • supportedOsVersions

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> supportedOsVersions()
        Returns:
        Set of Operating Systems (OS) supported by the component.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value map of resource tags for the component. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • type

        public com.pulumi.core.Output<java.lang.String> type()
        Returns:
        Type of the component.

      • uri

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> uri()
        Returns:
        S3 URI with data of the component. Exactly one of `data` and `uri` can be specified. > **NOTE:** Updating `data` or `uri` requires specifying a new `version`. This causes replacement of the resource. The `skipDestroy` argument can be used to retain the old version.

      • version

        public com.pulumi.core.Output<java.lang.String> version()
        Returns:
        Version of the component. The following arguments are optional:

      • get

        public static Component get​(java.lang.String name,
                            com.pulumi.core.Output<java.lang.String> id,
                            @Nullable
                            ComponentState 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.