1. Packages
  2. AWS Classic
  3. API Docs
  4. imagebuilder
  5. getComponent

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

aws.imagebuilder.getComponent

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    Provides details about an Image Builder Component.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.imagebuilder.getComponent({
        arn: "arn:aws:imagebuilder:us-west-2:aws:component/amazon-cloudwatch-agent-linux/1.0.0",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.imagebuilder.get_component(arn="arn:aws:imagebuilder:us-west-2:aws:component/amazon-cloudwatch-agent-linux/1.0.0")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/imagebuilder"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := imagebuilder.LookupComponent(ctx, &imagebuilder.LookupComponentArgs{
    			Arn: "arn:aws:imagebuilder:us-west-2:aws:component/amazon-cloudwatch-agent-linux/1.0.0",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Aws.ImageBuilder.GetComponent.Invoke(new()
        {
            Arn = "arn:aws:imagebuilder:us-west-2:aws:component/amazon-cloudwatch-agent-linux/1.0.0",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.imagebuilder.ImagebuilderFunctions;
    import com.pulumi.aws.imagebuilder.inputs.GetComponentArgs;
    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) {
            final var example = ImagebuilderFunctions.getComponent(GetComponentArgs.builder()
                .arn("arn:aws:imagebuilder:us-west-2:aws:component/amazon-cloudwatch-agent-linux/1.0.0")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: aws:imagebuilder:getComponent
          Arguments:
            arn: arn:aws:imagebuilder:us-west-2:aws:component/amazon-cloudwatch-agent-linux/1.0.0
    

    Using getComponent

    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 getComponent(args: GetComponentArgs, opts?: InvokeOptions): Promise<GetComponentResult>
    function getComponentOutput(args: GetComponentOutputArgs, opts?: InvokeOptions): Output<GetComponentResult>
    def get_component(arn: Optional[str] = None,
                      tags: Optional[Mapping[str, str]] = None,
                      opts: Optional[InvokeOptions] = None) -> GetComponentResult
    def get_component_output(arn: Optional[pulumi.Input[str]] = None,
                      tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetComponentResult]
    func LookupComponent(ctx *Context, args *LookupComponentArgs, opts ...InvokeOption) (*LookupComponentResult, error)
    func LookupComponentOutput(ctx *Context, args *LookupComponentOutputArgs, opts ...InvokeOption) LookupComponentResultOutput

    > Note: This function is named LookupComponent in the Go SDK.

    public static class GetComponent 
    {
        public static Task<GetComponentResult> InvokeAsync(GetComponentArgs args, InvokeOptions? opts = null)
        public static Output<GetComponentResult> Invoke(GetComponentInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetComponentResult> getComponent(GetComponentArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws:imagebuilder/getComponent:getComponent
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Arn string
    ARN of the component.
    Tags Dictionary<string, string>
    Key-value map of resource tags for the component.
    Arn string
    ARN of the component.
    Tags map[string]string
    Key-value map of resource tags for the component.
    arn String
    ARN of the component.
    tags Map<String,String>
    Key-value map of resource tags for the component.
    arn string
    ARN of the component.
    tags {[key: string]: string}
    Key-value map of resource tags for the component.
    arn str
    ARN of the component.
    tags Mapping[str, str]
    Key-value map of resource tags for the component.
    arn String
    ARN of the component.
    tags Map<String>
    Key-value map of resource tags for the component.

    getComponent Result

    The following output properties are available:

    Arn string
    ChangeDescription string
    Change description of the component.
    Data string
    Data of the component.
    DateCreated string
    Date the component was created.
    Description string
    Description of the component.
    Encrypted bool
    Encryption status of the component.
    Id string
    The provider-assigned unique ID for this managed resource.
    KmsKeyId string
    ARN of the Key Management Service (KMS) Key used to encrypt the component.
    Name string
    Name of the component.
    Owner string
    Owner of the component.
    Platform string
    Platform of the component.
    SupportedOsVersions List<string>
    Operating Systems (OSes) supported by the component.
    Tags Dictionary<string, string>
    Key-value map of resource tags for the component.
    Type string
    Type of the component.
    Version string
    Version of the component.
    Arn string
    ChangeDescription string
    Change description of the component.
    Data string
    Data of the component.
    DateCreated string
    Date the component was created.
    Description string
    Description of the component.
    Encrypted bool
    Encryption status of the component.
    Id string
    The provider-assigned unique ID for this managed resource.
    KmsKeyId string
    ARN of the Key Management Service (KMS) Key used to encrypt the component.
    Name string
    Name of the component.
    Owner string
    Owner of the component.
    Platform string
    Platform of the component.
    SupportedOsVersions []string
    Operating Systems (OSes) supported by the component.
    Tags map[string]string
    Key-value map of resource tags for the component.
    Type string
    Type of the component.
    Version string
    Version of the component.
    arn String
    changeDescription String
    Change description of the component.
    data String
    Data of the component.
    dateCreated String
    Date the component was created.
    description String
    Description of the component.
    encrypted Boolean
    Encryption status of the component.
    id String
    The provider-assigned unique ID for this managed resource.
    kmsKeyId String
    ARN of the Key Management Service (KMS) Key used to encrypt the component.
    name String
    Name of the component.
    owner String
    Owner of the component.
    platform String
    Platform of the component.
    supportedOsVersions List<String>
    Operating Systems (OSes) supported by the component.
    tags Map<String,String>
    Key-value map of resource tags for the component.
    type String
    Type of the component.
    version String
    Version of the component.
    arn string
    changeDescription string
    Change description of the component.
    data string
    Data of the component.
    dateCreated string
    Date the component was created.
    description string
    Description of the component.
    encrypted boolean
    Encryption status of the component.
    id string
    The provider-assigned unique ID for this managed resource.
    kmsKeyId string
    ARN of the Key Management Service (KMS) Key used to encrypt the component.
    name string
    Name of the component.
    owner string
    Owner of the component.
    platform string
    Platform of the component.
    supportedOsVersions string[]
    Operating Systems (OSes) supported by the component.
    tags {[key: string]: string}
    Key-value map of resource tags for the component.
    type string
    Type of the component.
    version string
    Version of the component.
    arn str
    change_description str
    Change description of the component.
    data str
    Data of the component.
    date_created str
    Date the component was created.
    description str
    Description of the component.
    encrypted bool
    Encryption status of the component.
    id str
    The provider-assigned unique ID for this managed resource.
    kms_key_id str
    ARN of the Key Management Service (KMS) Key used to encrypt the component.
    name str
    Name of the component.
    owner str
    Owner of the component.
    platform str
    Platform of the component.
    supported_os_versions Sequence[str]
    Operating Systems (OSes) supported by the component.
    tags Mapping[str, str]
    Key-value map of resource tags for the component.
    type str
    Type of the component.
    version str
    Version of the component.
    arn String
    changeDescription String
    Change description of the component.
    data String
    Data of the component.
    dateCreated String
    Date the component was created.
    description String
    Description of the component.
    encrypted Boolean
    Encryption status of the component.
    id String
    The provider-assigned unique ID for this managed resource.
    kmsKeyId String
    ARN of the Key Management Service (KMS) Key used to encrypt the component.
    name String
    Name of the component.
    owner String
    Owner of the component.
    platform String
    Platform of the component.
    supportedOsVersions List<String>
    Operating Systems (OSes) supported by the component.
    tags Map<String>
    Key-value map of resource tags for the component.
    type String
    Type of the component.
    version String
    Version of the component.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi