1. Packages
  2. AWS
  3. API Docs
  4. imagebuilder
  5. InfrastructureConfiguration
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.imagebuilder.InfrastructureConfiguration

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Manages an Image Builder Infrastructure Configuration.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.imagebuilder.InfrastructureConfiguration("example", {
        description: "example description",
        instanceProfileName: exampleAwsIamInstanceProfile.name,
        instanceTypes: [
            "t2.nano",
            "t3.micro",
        ],
        keyPair: exampleAwsKeyPair.keyName,
        name: "example",
        securityGroupIds: [exampleAwsSecurityGroup.id],
        snsTopicArn: exampleAwsSnsTopic.arn,
        subnetId: main.id,
        terminateInstanceOnFailure: true,
        logging: {
            s3Logs: {
                s3BucketName: exampleAwsS3Bucket.bucket,
                s3KeyPrefix: "logs",
            },
        },
        tags: {
            foo: "bar",
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.imagebuilder.InfrastructureConfiguration("example",
        description="example description",
        instance_profile_name=example_aws_iam_instance_profile["name"],
        instance_types=[
            "t2.nano",
            "t3.micro",
        ],
        key_pair=example_aws_key_pair["keyName"],
        name="example",
        security_group_ids=[example_aws_security_group["id"]],
        sns_topic_arn=example_aws_sns_topic["arn"],
        subnet_id=main["id"],
        terminate_instance_on_failure=True,
        logging={
            "s3_logs": {
                "s3_bucket_name": example_aws_s3_bucket["bucket"],
                "s3_key_prefix": "logs",
            },
        },
        tags={
            "foo": "bar",
        })
    
    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.NewInfrastructureConfiguration(ctx, "example", &imagebuilder.InfrastructureConfigurationArgs{
    			Description:         pulumi.String("example description"),
    			InstanceProfileName: pulumi.Any(exampleAwsIamInstanceProfile.Name),
    			InstanceTypes: pulumi.StringArray{
    				pulumi.String("t2.nano"),
    				pulumi.String("t3.micro"),
    			},
    			KeyPair: pulumi.Any(exampleAwsKeyPair.KeyName),
    			Name:    pulumi.String("example"),
    			SecurityGroupIds: pulumi.StringArray{
    				exampleAwsSecurityGroup.Id,
    			},
    			SnsTopicArn:                pulumi.Any(exampleAwsSnsTopic.Arn),
    			SubnetId:                   pulumi.Any(main.Id),
    			TerminateInstanceOnFailure: pulumi.Bool(true),
    			Logging: &imagebuilder.InfrastructureConfigurationLoggingArgs{
    				S3Logs: &imagebuilder.InfrastructureConfigurationLoggingS3LogsArgs{
    					S3BucketName: pulumi.Any(exampleAwsS3Bucket.Bucket),
    					S3KeyPrefix:  pulumi.String("logs"),
    				},
    			},
    			Tags: pulumi.StringMap{
    				"foo": pulumi.String("bar"),
    			},
    		})
    		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 = new Aws.ImageBuilder.InfrastructureConfiguration("example", new()
        {
            Description = "example description",
            InstanceProfileName = exampleAwsIamInstanceProfile.Name,
            InstanceTypes = new[]
            {
                "t2.nano",
                "t3.micro",
            },
            KeyPair = exampleAwsKeyPair.KeyName,
            Name = "example",
            SecurityGroupIds = new[]
            {
                exampleAwsSecurityGroup.Id,
            },
            SnsTopicArn = exampleAwsSnsTopic.Arn,
            SubnetId = main.Id,
            TerminateInstanceOnFailure = true,
            Logging = new Aws.ImageBuilder.Inputs.InfrastructureConfigurationLoggingArgs
            {
                S3Logs = new Aws.ImageBuilder.Inputs.InfrastructureConfigurationLoggingS3LogsArgs
                {
                    S3BucketName = exampleAwsS3Bucket.Bucket,
                    S3KeyPrefix = "logs",
                },
            },
            Tags = 
            {
                { "foo", "bar" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.imagebuilder.InfrastructureConfiguration;
    import com.pulumi.aws.imagebuilder.InfrastructureConfigurationArgs;
    import com.pulumi.aws.imagebuilder.inputs.InfrastructureConfigurationLoggingArgs;
    import com.pulumi.aws.imagebuilder.inputs.InfrastructureConfigurationLoggingS3LogsArgs;
    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 InfrastructureConfiguration("example", InfrastructureConfigurationArgs.builder()
                .description("example description")
                .instanceProfileName(exampleAwsIamInstanceProfile.name())
                .instanceTypes(            
                    "t2.nano",
                    "t3.micro")
                .keyPair(exampleAwsKeyPair.keyName())
                .name("example")
                .securityGroupIds(exampleAwsSecurityGroup.id())
                .snsTopicArn(exampleAwsSnsTopic.arn())
                .subnetId(main.id())
                .terminateInstanceOnFailure(true)
                .logging(InfrastructureConfigurationLoggingArgs.builder()
                    .s3Logs(InfrastructureConfigurationLoggingS3LogsArgs.builder()
                        .s3BucketName(exampleAwsS3Bucket.bucket())
                        .s3KeyPrefix("logs")
                        .build())
                    .build())
                .tags(Map.of("foo", "bar"))
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:imagebuilder:InfrastructureConfiguration
        properties:
          description: example description
          instanceProfileName: ${exampleAwsIamInstanceProfile.name}
          instanceTypes:
            - t2.nano
            - t3.micro
          keyPair: ${exampleAwsKeyPair.keyName}
          name: example
          securityGroupIds:
            - ${exampleAwsSecurityGroup.id}
          snsTopicArn: ${exampleAwsSnsTopic.arn}
          subnetId: ${main.id}
          terminateInstanceOnFailure: true
          logging:
            s3Logs:
              s3BucketName: ${exampleAwsS3Bucket.bucket}
              s3KeyPrefix: logs
          tags:
            foo: bar
    

    Create InfrastructureConfiguration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new InfrastructureConfiguration(name: string, args: InfrastructureConfigurationArgs, opts?: CustomResourceOptions);
    @overload
    def InfrastructureConfiguration(resource_name: str,
                                    args: InfrastructureConfigurationArgs,
                                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def InfrastructureConfiguration(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    instance_profile_name: Optional[str] = None,
                                    name: Optional[str] = None,
                                    instance_metadata_options: Optional[InfrastructureConfigurationInstanceMetadataOptionsArgs] = None,
                                    instance_types: Optional[Sequence[str]] = None,
                                    key_pair: Optional[str] = None,
                                    logging: Optional[InfrastructureConfigurationLoggingArgs] = None,
                                    description: Optional[str] = None,
                                    resource_tags: Optional[Mapping[str, str]] = None,
                                    security_group_ids: Optional[Sequence[str]] = None,
                                    sns_topic_arn: Optional[str] = None,
                                    subnet_id: Optional[str] = None,
                                    tags: Optional[Mapping[str, str]] = None,
                                    terminate_instance_on_failure: Optional[bool] = None)
    func NewInfrastructureConfiguration(ctx *Context, name string, args InfrastructureConfigurationArgs, opts ...ResourceOption) (*InfrastructureConfiguration, error)
    public InfrastructureConfiguration(string name, InfrastructureConfigurationArgs args, CustomResourceOptions? opts = null)
    public InfrastructureConfiguration(String name, InfrastructureConfigurationArgs args)
    public InfrastructureConfiguration(String name, InfrastructureConfigurationArgs args, CustomResourceOptions options)
    
    type: aws:imagebuilder:InfrastructureConfiguration
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args InfrastructureConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args InfrastructureConfigurationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args InfrastructureConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InfrastructureConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InfrastructureConfigurationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var infrastructureConfigurationResource = new Aws.ImageBuilder.InfrastructureConfiguration("infrastructureConfigurationResource", new()
    {
        InstanceProfileName = "string",
        Name = "string",
        InstanceMetadataOptions = new Aws.ImageBuilder.Inputs.InfrastructureConfigurationInstanceMetadataOptionsArgs
        {
            HttpPutResponseHopLimit = 0,
            HttpTokens = "string",
        },
        InstanceTypes = new[]
        {
            "string",
        },
        KeyPair = "string",
        Logging = new Aws.ImageBuilder.Inputs.InfrastructureConfigurationLoggingArgs
        {
            S3Logs = new Aws.ImageBuilder.Inputs.InfrastructureConfigurationLoggingS3LogsArgs
            {
                S3BucketName = "string",
                S3KeyPrefix = "string",
            },
        },
        Description = "string",
        ResourceTags = 
        {
            { "string", "string" },
        },
        SecurityGroupIds = new[]
        {
            "string",
        },
        SnsTopicArn = "string",
        SubnetId = "string",
        Tags = 
        {
            { "string", "string" },
        },
        TerminateInstanceOnFailure = false,
    });
    
    example, err := imagebuilder.NewInfrastructureConfiguration(ctx, "infrastructureConfigurationResource", &imagebuilder.InfrastructureConfigurationArgs{
    	InstanceProfileName: pulumi.String("string"),
    	Name:                pulumi.String("string"),
    	InstanceMetadataOptions: &imagebuilder.InfrastructureConfigurationInstanceMetadataOptionsArgs{
    		HttpPutResponseHopLimit: pulumi.Int(0),
    		HttpTokens:              pulumi.String("string"),
    	},
    	InstanceTypes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	KeyPair: pulumi.String("string"),
    	Logging: &imagebuilder.InfrastructureConfigurationLoggingArgs{
    		S3Logs: &imagebuilder.InfrastructureConfigurationLoggingS3LogsArgs{
    			S3BucketName: pulumi.String("string"),
    			S3KeyPrefix:  pulumi.String("string"),
    		},
    	},
    	Description: pulumi.String("string"),
    	ResourceTags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	SecurityGroupIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	SnsTopicArn: pulumi.String("string"),
    	SubnetId:    pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	TerminateInstanceOnFailure: pulumi.Bool(false),
    })
    
    var infrastructureConfigurationResource = new InfrastructureConfiguration("infrastructureConfigurationResource", InfrastructureConfigurationArgs.builder()
        .instanceProfileName("string")
        .name("string")
        .instanceMetadataOptions(InfrastructureConfigurationInstanceMetadataOptionsArgs.builder()
            .httpPutResponseHopLimit(0)
            .httpTokens("string")
            .build())
        .instanceTypes("string")
        .keyPair("string")
        .logging(InfrastructureConfigurationLoggingArgs.builder()
            .s3Logs(InfrastructureConfigurationLoggingS3LogsArgs.builder()
                .s3BucketName("string")
                .s3KeyPrefix("string")
                .build())
            .build())
        .description("string")
        .resourceTags(Map.of("string", "string"))
        .securityGroupIds("string")
        .snsTopicArn("string")
        .subnetId("string")
        .tags(Map.of("string", "string"))
        .terminateInstanceOnFailure(false)
        .build());
    
    infrastructure_configuration_resource = aws.imagebuilder.InfrastructureConfiguration("infrastructureConfigurationResource",
        instance_profile_name="string",
        name="string",
        instance_metadata_options={
            "http_put_response_hop_limit": 0,
            "http_tokens": "string",
        },
        instance_types=["string"],
        key_pair="string",
        logging={
            "s3_logs": {
                "s3_bucket_name": "string",
                "s3_key_prefix": "string",
            },
        },
        description="string",
        resource_tags={
            "string": "string",
        },
        security_group_ids=["string"],
        sns_topic_arn="string",
        subnet_id="string",
        tags={
            "string": "string",
        },
        terminate_instance_on_failure=False)
    
    const infrastructureConfigurationResource = new aws.imagebuilder.InfrastructureConfiguration("infrastructureConfigurationResource", {
        instanceProfileName: "string",
        name: "string",
        instanceMetadataOptions: {
            httpPutResponseHopLimit: 0,
            httpTokens: "string",
        },
        instanceTypes: ["string"],
        keyPair: "string",
        logging: {
            s3Logs: {
                s3BucketName: "string",
                s3KeyPrefix: "string",
            },
        },
        description: "string",
        resourceTags: {
            string: "string",
        },
        securityGroupIds: ["string"],
        snsTopicArn: "string",
        subnetId: "string",
        tags: {
            string: "string",
        },
        terminateInstanceOnFailure: false,
    });
    
    type: aws:imagebuilder:InfrastructureConfiguration
    properties:
        description: string
        instanceMetadataOptions:
            httpPutResponseHopLimit: 0
            httpTokens: string
        instanceProfileName: string
        instanceTypes:
            - string
        keyPair: string
        logging:
            s3Logs:
                s3BucketName: string
                s3KeyPrefix: string
        name: string
        resourceTags:
            string: string
        securityGroupIds:
            - string
        snsTopicArn: string
        subnetId: string
        tags:
            string: string
        terminateInstanceOnFailure: false
    

    InfrastructureConfiguration Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The InfrastructureConfiguration resource accepts the following input properties:

    InstanceProfileName string
    Name of IAM Instance Profile.
    Description string
    Description for the configuration.
    InstanceMetadataOptions InfrastructureConfigurationInstanceMetadataOptions
    Configuration block with instance metadata options for the HTTP requests that pipeline builds use to launch EC2 build and test instances. Detailed below.
    InstanceTypes List<string>
    Set of EC2 Instance Types.
    KeyPair string
    Name of EC2 Key Pair.
    Logging InfrastructureConfigurationLogging
    Configuration block with logging settings. Detailed below.
    Name string

    Name for the configuration.

    The following arguments are optional:

    ResourceTags Dictionary<string, string>
    Key-value map of resource tags to assign to infrastructure created by the configuration.
    SecurityGroupIds List<string>
    Set of EC2 Security Group identifiers.
    SnsTopicArn string
    Amazon Resource Name (ARN) of SNS Topic.
    SubnetId string
    EC2 Subnet identifier. Also requires security_group_ids argument.
    Tags Dictionary<string, string>
    Key-value map of resource tags to assign to the configuration. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TerminateInstanceOnFailure bool
    Enable if the instance should be terminated when the pipeline fails. Defaults to false.
    InstanceProfileName string
    Name of IAM Instance Profile.
    Description string
    Description for the configuration.
    InstanceMetadataOptions InfrastructureConfigurationInstanceMetadataOptionsArgs
    Configuration block with instance metadata options for the HTTP requests that pipeline builds use to launch EC2 build and test instances. Detailed below.
    InstanceTypes []string
    Set of EC2 Instance Types.
    KeyPair string
    Name of EC2 Key Pair.
    Logging InfrastructureConfigurationLoggingArgs
    Configuration block with logging settings. Detailed below.
    Name string

    Name for the configuration.

    The following arguments are optional:

    ResourceTags map[string]string
    Key-value map of resource tags to assign to infrastructure created by the configuration.
    SecurityGroupIds []string
    Set of EC2 Security Group identifiers.
    SnsTopicArn string
    Amazon Resource Name (ARN) of SNS Topic.
    SubnetId string
    EC2 Subnet identifier. Also requires security_group_ids argument.
    Tags map[string]string
    Key-value map of resource tags to assign to the configuration. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TerminateInstanceOnFailure bool
    Enable if the instance should be terminated when the pipeline fails. Defaults to false.
    instanceProfileName String
    Name of IAM Instance Profile.
    description String
    Description for the configuration.
    instanceMetadataOptions InfrastructureConfigurationInstanceMetadataOptions
    Configuration block with instance metadata options for the HTTP requests that pipeline builds use to launch EC2 build and test instances. Detailed below.
    instanceTypes List<String>
    Set of EC2 Instance Types.
    keyPair String
    Name of EC2 Key Pair.
    logging InfrastructureConfigurationLogging
    Configuration block with logging settings. Detailed below.
    name String

    Name for the configuration.

    The following arguments are optional:

    resourceTags Map<String,String>
    Key-value map of resource tags to assign to infrastructure created by the configuration.
    securityGroupIds List<String>
    Set of EC2 Security Group identifiers.
    snsTopicArn String
    Amazon Resource Name (ARN) of SNS Topic.
    subnetId String
    EC2 Subnet identifier. Also requires security_group_ids argument.
    tags Map<String,String>
    Key-value map of resource tags to assign to the configuration. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    terminateInstanceOnFailure Boolean
    Enable if the instance should be terminated when the pipeline fails. Defaults to false.
    instanceProfileName string
    Name of IAM Instance Profile.
    description string
    Description for the configuration.
    instanceMetadataOptions InfrastructureConfigurationInstanceMetadataOptions
    Configuration block with instance metadata options for the HTTP requests that pipeline builds use to launch EC2 build and test instances. Detailed below.
    instanceTypes string[]
    Set of EC2 Instance Types.
    keyPair string
    Name of EC2 Key Pair.
    logging InfrastructureConfigurationLogging
    Configuration block with logging settings. Detailed below.
    name string

    Name for the configuration.

    The following arguments are optional:

    resourceTags {[key: string]: string}
    Key-value map of resource tags to assign to infrastructure created by the configuration.
    securityGroupIds string[]
    Set of EC2 Security Group identifiers.
    snsTopicArn string
    Amazon Resource Name (ARN) of SNS Topic.
    subnetId string
    EC2 Subnet identifier. Also requires security_group_ids argument.
    tags {[key: string]: string}
    Key-value map of resource tags to assign to the configuration. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    terminateInstanceOnFailure boolean
    Enable if the instance should be terminated when the pipeline fails. Defaults to false.
    instance_profile_name str
    Name of IAM Instance Profile.
    description str
    Description for the configuration.
    instance_metadata_options InfrastructureConfigurationInstanceMetadataOptionsArgs
    Configuration block with instance metadata options for the HTTP requests that pipeline builds use to launch EC2 build and test instances. Detailed below.
    instance_types Sequence[str]
    Set of EC2 Instance Types.
    key_pair str
    Name of EC2 Key Pair.
    logging InfrastructureConfigurationLoggingArgs
    Configuration block with logging settings. Detailed below.
    name str

    Name for the configuration.

    The following arguments are optional:

    resource_tags Mapping[str, str]
    Key-value map of resource tags to assign to infrastructure created by the configuration.
    security_group_ids Sequence[str]
    Set of EC2 Security Group identifiers.
    sns_topic_arn str
    Amazon Resource Name (ARN) of SNS Topic.
    subnet_id str
    EC2 Subnet identifier. Also requires security_group_ids argument.
    tags Mapping[str, str]
    Key-value map of resource tags to assign to the configuration. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    terminate_instance_on_failure bool
    Enable if the instance should be terminated when the pipeline fails. Defaults to false.
    instanceProfileName String
    Name of IAM Instance Profile.
    description String
    Description for the configuration.
    instanceMetadataOptions Property Map
    Configuration block with instance metadata options for the HTTP requests that pipeline builds use to launch EC2 build and test instances. Detailed below.
    instanceTypes List<String>
    Set of EC2 Instance Types.
    keyPair String
    Name of EC2 Key Pair.
    logging Property Map
    Configuration block with logging settings. Detailed below.
    name String

    Name for the configuration.

    The following arguments are optional:

    resourceTags Map<String>
    Key-value map of resource tags to assign to infrastructure created by the configuration.
    securityGroupIds List<String>
    Set of EC2 Security Group identifiers.
    snsTopicArn String
    Amazon Resource Name (ARN) of SNS Topic.
    subnetId String
    EC2 Subnet identifier. Also requires security_group_ids argument.
    tags Map<String>
    Key-value map of resource tags to assign to the configuration. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    terminateInstanceOnFailure Boolean
    Enable if the instance should be terminated when the pipeline fails. Defaults to false.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the InfrastructureConfiguration resource produces the following output properties:

    Arn string
    Amazon Resource Name (ARN) of the configuration.
    DateCreated string
    Date when the configuration was created.
    DateUpdated string
    Date when the configuration was updated.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    Amazon Resource Name (ARN) of the configuration.
    DateCreated string
    Date when the configuration was created.
    DateUpdated string
    Date when the configuration was updated.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of the configuration.
    dateCreated String
    Date when the configuration was created.
    dateUpdated String
    Date when the configuration was updated.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    Amazon Resource Name (ARN) of the configuration.
    dateCreated string
    Date when the configuration was created.
    dateUpdated string
    Date when the configuration was updated.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    Amazon Resource Name (ARN) of the configuration.
    date_created str
    Date when the configuration was created.
    date_updated str
    Date when the configuration was updated.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of the configuration.
    dateCreated String
    Date when the configuration was created.
    dateUpdated String
    Date when the configuration was updated.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing InfrastructureConfiguration Resource

    Get an existing InfrastructureConfiguration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: InfrastructureConfigurationState, opts?: CustomResourceOptions): InfrastructureConfiguration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            date_created: Optional[str] = None,
            date_updated: Optional[str] = None,
            description: Optional[str] = None,
            instance_metadata_options: Optional[InfrastructureConfigurationInstanceMetadataOptionsArgs] = None,
            instance_profile_name: Optional[str] = None,
            instance_types: Optional[Sequence[str]] = None,
            key_pair: Optional[str] = None,
            logging: Optional[InfrastructureConfigurationLoggingArgs] = None,
            name: Optional[str] = None,
            resource_tags: Optional[Mapping[str, str]] = None,
            security_group_ids: Optional[Sequence[str]] = None,
            sns_topic_arn: Optional[str] = None,
            subnet_id: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            terminate_instance_on_failure: Optional[bool] = None) -> InfrastructureConfiguration
    func GetInfrastructureConfiguration(ctx *Context, name string, id IDInput, state *InfrastructureConfigurationState, opts ...ResourceOption) (*InfrastructureConfiguration, error)
    public static InfrastructureConfiguration Get(string name, Input<string> id, InfrastructureConfigurationState? state, CustomResourceOptions? opts = null)
    public static InfrastructureConfiguration get(String name, Output<String> id, InfrastructureConfigurationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    Amazon Resource Name (ARN) of the configuration.
    DateCreated string
    Date when the configuration was created.
    DateUpdated string
    Date when the configuration was updated.
    Description string
    Description for the configuration.
    InstanceMetadataOptions InfrastructureConfigurationInstanceMetadataOptions
    Configuration block with instance metadata options for the HTTP requests that pipeline builds use to launch EC2 build and test instances. Detailed below.
    InstanceProfileName string
    Name of IAM Instance Profile.
    InstanceTypes List<string>
    Set of EC2 Instance Types.
    KeyPair string
    Name of EC2 Key Pair.
    Logging InfrastructureConfigurationLogging
    Configuration block with logging settings. Detailed below.
    Name string

    Name for the configuration.

    The following arguments are optional:

    ResourceTags Dictionary<string, string>
    Key-value map of resource tags to assign to infrastructure created by the configuration.
    SecurityGroupIds List<string>
    Set of EC2 Security Group identifiers.
    SnsTopicArn string
    Amazon Resource Name (ARN) of SNS Topic.
    SubnetId string
    EC2 Subnet identifier. Also requires security_group_ids argument.
    Tags Dictionary<string, string>
    Key-value map of resource tags to assign to the configuration. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    TerminateInstanceOnFailure bool
    Enable if the instance should be terminated when the pipeline fails. Defaults to false.
    Arn string
    Amazon Resource Name (ARN) of the configuration.
    DateCreated string
    Date when the configuration was created.
    DateUpdated string
    Date when the configuration was updated.
    Description string
    Description for the configuration.
    InstanceMetadataOptions InfrastructureConfigurationInstanceMetadataOptionsArgs
    Configuration block with instance metadata options for the HTTP requests that pipeline builds use to launch EC2 build and test instances. Detailed below.
    InstanceProfileName string
    Name of IAM Instance Profile.
    InstanceTypes []string
    Set of EC2 Instance Types.
    KeyPair string
    Name of EC2 Key Pair.
    Logging InfrastructureConfigurationLoggingArgs
    Configuration block with logging settings. Detailed below.
    Name string

    Name for the configuration.

    The following arguments are optional:

    ResourceTags map[string]string
    Key-value map of resource tags to assign to infrastructure created by the configuration.
    SecurityGroupIds []string
    Set of EC2 Security Group identifiers.
    SnsTopicArn string
    Amazon Resource Name (ARN) of SNS Topic.
    SubnetId string
    EC2 Subnet identifier. Also requires security_group_ids argument.
    Tags map[string]string
    Key-value map of resource tags to assign to the configuration. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    TerminateInstanceOnFailure bool
    Enable if the instance should be terminated when the pipeline fails. Defaults to false.
    arn String
    Amazon Resource Name (ARN) of the configuration.
    dateCreated String
    Date when the configuration was created.
    dateUpdated String
    Date when the configuration was updated.
    description String
    Description for the configuration.
    instanceMetadataOptions InfrastructureConfigurationInstanceMetadataOptions
    Configuration block with instance metadata options for the HTTP requests that pipeline builds use to launch EC2 build and test instances. Detailed below.
    instanceProfileName String
    Name of IAM Instance Profile.
    instanceTypes List<String>
    Set of EC2 Instance Types.
    keyPair String
    Name of EC2 Key Pair.
    logging InfrastructureConfigurationLogging
    Configuration block with logging settings. Detailed below.
    name String

    Name for the configuration.

    The following arguments are optional:

    resourceTags Map<String,String>
    Key-value map of resource tags to assign to infrastructure created by the configuration.
    securityGroupIds List<String>
    Set of EC2 Security Group identifiers.
    snsTopicArn String
    Amazon Resource Name (ARN) of SNS Topic.
    subnetId String
    EC2 Subnet identifier. Also requires security_group_ids argument.
    tags Map<String,String>
    Key-value map of resource tags to assign to the configuration. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    terminateInstanceOnFailure Boolean
    Enable if the instance should be terminated when the pipeline fails. Defaults to false.
    arn string
    Amazon Resource Name (ARN) of the configuration.
    dateCreated string
    Date when the configuration was created.
    dateUpdated string
    Date when the configuration was updated.
    description string
    Description for the configuration.
    instanceMetadataOptions InfrastructureConfigurationInstanceMetadataOptions
    Configuration block with instance metadata options for the HTTP requests that pipeline builds use to launch EC2 build and test instances. Detailed below.
    instanceProfileName string
    Name of IAM Instance Profile.
    instanceTypes string[]
    Set of EC2 Instance Types.
    keyPair string
    Name of EC2 Key Pair.
    logging InfrastructureConfigurationLogging
    Configuration block with logging settings. Detailed below.
    name string

    Name for the configuration.

    The following arguments are optional:

    resourceTags {[key: string]: string}
    Key-value map of resource tags to assign to infrastructure created by the configuration.
    securityGroupIds string[]
    Set of EC2 Security Group identifiers.
    snsTopicArn string
    Amazon Resource Name (ARN) of SNS Topic.
    subnetId string
    EC2 Subnet identifier. Also requires security_group_ids argument.
    tags {[key: string]: string}
    Key-value map of resource tags to assign to the configuration. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    terminateInstanceOnFailure boolean
    Enable if the instance should be terminated when the pipeline fails. Defaults to false.
    arn str
    Amazon Resource Name (ARN) of the configuration.
    date_created str
    Date when the configuration was created.
    date_updated str
    Date when the configuration was updated.
    description str
    Description for the configuration.
    instance_metadata_options InfrastructureConfigurationInstanceMetadataOptionsArgs
    Configuration block with instance metadata options for the HTTP requests that pipeline builds use to launch EC2 build and test instances. Detailed below.
    instance_profile_name str
    Name of IAM Instance Profile.
    instance_types Sequence[str]
    Set of EC2 Instance Types.
    key_pair str
    Name of EC2 Key Pair.
    logging InfrastructureConfigurationLoggingArgs
    Configuration block with logging settings. Detailed below.
    name str

    Name for the configuration.

    The following arguments are optional:

    resource_tags Mapping[str, str]
    Key-value map of resource tags to assign to infrastructure created by the configuration.
    security_group_ids Sequence[str]
    Set of EC2 Security Group identifiers.
    sns_topic_arn str
    Amazon Resource Name (ARN) of SNS Topic.
    subnet_id str
    EC2 Subnet identifier. Also requires security_group_ids argument.
    tags Mapping[str, str]
    Key-value map of resource tags to assign to the configuration. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    terminate_instance_on_failure bool
    Enable if the instance should be terminated when the pipeline fails. Defaults to false.
    arn String
    Amazon Resource Name (ARN) of the configuration.
    dateCreated String
    Date when the configuration was created.
    dateUpdated String
    Date when the configuration was updated.
    description String
    Description for the configuration.
    instanceMetadataOptions Property Map
    Configuration block with instance metadata options for the HTTP requests that pipeline builds use to launch EC2 build and test instances. Detailed below.
    instanceProfileName String
    Name of IAM Instance Profile.
    instanceTypes List<String>
    Set of EC2 Instance Types.
    keyPair String
    Name of EC2 Key Pair.
    logging Property Map
    Configuration block with logging settings. Detailed below.
    name String

    Name for the configuration.

    The following arguments are optional:

    resourceTags Map<String>
    Key-value map of resource tags to assign to infrastructure created by the configuration.
    securityGroupIds List<String>
    Set of EC2 Security Group identifiers.
    snsTopicArn String
    Amazon Resource Name (ARN) of SNS Topic.
    subnetId String
    EC2 Subnet identifier. Also requires security_group_ids argument.
    tags Map<String>
    Key-value map of resource tags to assign to the configuration. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    terminateInstanceOnFailure Boolean
    Enable if the instance should be terminated when the pipeline fails. Defaults to false.

    Supporting Types

    InfrastructureConfigurationInstanceMetadataOptions, InfrastructureConfigurationInstanceMetadataOptionsArgs

    HttpPutResponseHopLimit int
    The number of hops that an instance can traverse to reach its destonation.
    HttpTokens string
    Whether a signed token is required for instance metadata retrieval requests. Valid values: required, optional.
    HttpPutResponseHopLimit int
    The number of hops that an instance can traverse to reach its destonation.
    HttpTokens string
    Whether a signed token is required for instance metadata retrieval requests. Valid values: required, optional.
    httpPutResponseHopLimit Integer
    The number of hops that an instance can traverse to reach its destonation.
    httpTokens String
    Whether a signed token is required for instance metadata retrieval requests. Valid values: required, optional.
    httpPutResponseHopLimit number
    The number of hops that an instance can traverse to reach its destonation.
    httpTokens string
    Whether a signed token is required for instance metadata retrieval requests. Valid values: required, optional.
    http_put_response_hop_limit int
    The number of hops that an instance can traverse to reach its destonation.
    http_tokens str
    Whether a signed token is required for instance metadata retrieval requests. Valid values: required, optional.
    httpPutResponseHopLimit Number
    The number of hops that an instance can traverse to reach its destonation.
    httpTokens String
    Whether a signed token is required for instance metadata retrieval requests. Valid values: required, optional.

    InfrastructureConfigurationLogging, InfrastructureConfigurationLoggingArgs

    S3Logs InfrastructureConfigurationLoggingS3Logs
    Configuration block with S3 logging settings. Detailed below.
    S3Logs InfrastructureConfigurationLoggingS3Logs
    Configuration block with S3 logging settings. Detailed below.
    s3Logs InfrastructureConfigurationLoggingS3Logs
    Configuration block with S3 logging settings. Detailed below.
    s3Logs InfrastructureConfigurationLoggingS3Logs
    Configuration block with S3 logging settings. Detailed below.
    s3_logs InfrastructureConfigurationLoggingS3Logs
    Configuration block with S3 logging settings. Detailed below.
    s3Logs Property Map
    Configuration block with S3 logging settings. Detailed below.

    InfrastructureConfigurationLoggingS3Logs, InfrastructureConfigurationLoggingS3LogsArgs

    S3BucketName string

    Name of the S3 Bucket.

    The following arguments are optional:

    S3KeyPrefix string
    Prefix to use for S3 logs. Defaults to /.
    S3BucketName string

    Name of the S3 Bucket.

    The following arguments are optional:

    S3KeyPrefix string
    Prefix to use for S3 logs. Defaults to /.
    s3BucketName String

    Name of the S3 Bucket.

    The following arguments are optional:

    s3KeyPrefix String
    Prefix to use for S3 logs. Defaults to /.
    s3BucketName string

    Name of the S3 Bucket.

    The following arguments are optional:

    s3KeyPrefix string
    Prefix to use for S3 logs. Defaults to /.
    s3_bucket_name str

    Name of the S3 Bucket.

    The following arguments are optional:

    s3_key_prefix str
    Prefix to use for S3 logs. Defaults to /.
    s3BucketName String

    Name of the S3 Bucket.

    The following arguments are optional:

    s3KeyPrefix String
    Prefix to use for S3 logs. Defaults to /.

    Import

    Using pulumi import, import aws_imagebuilder_infrastructure_configuration using the Amazon Resource Name (ARN). For example:

    $ pulumi import aws:imagebuilder/infrastructureConfiguration:InfrastructureConfiguration example arn:aws:imagebuilder:us-east-1:123456789012:infrastructure-configuration/example
    

    To learn more about importing existing cloud resources, see Importing resources.

    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
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi