We recommend new projects start with resources from the AWS provider.
aws-native.imagebuilder.DistributionConfiguration
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Resource schema for AWS::ImageBuilder::DistributionConfiguration
Create DistributionConfiguration Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DistributionConfiguration(name: string, args: DistributionConfigurationArgs, opts?: CustomResourceOptions);
@overload
def DistributionConfiguration(resource_name: str,
args: DistributionConfigurationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DistributionConfiguration(resource_name: str,
opts: Optional[ResourceOptions] = None,
distributions: Optional[Sequence[DistributionConfigurationDistributionArgs]] = None,
description: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
func NewDistributionConfiguration(ctx *Context, name string, args DistributionConfigurationArgs, opts ...ResourceOption) (*DistributionConfiguration, error)
public DistributionConfiguration(string name, DistributionConfigurationArgs args, CustomResourceOptions? opts = null)
public DistributionConfiguration(String name, DistributionConfigurationArgs args)
public DistributionConfiguration(String name, DistributionConfigurationArgs args, CustomResourceOptions options)
type: aws-native:imagebuilder:DistributionConfiguration
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 DistributionConfigurationArgs
- 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 DistributionConfigurationArgs
- 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 DistributionConfigurationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DistributionConfigurationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DistributionConfigurationArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
DistributionConfiguration 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 DistributionConfiguration resource accepts the following input properties:
- Distributions
List<Pulumi.
Aws Native. Image Builder. Inputs. Distribution Configuration Distribution> - The distributions of the distribution configuration.
- Description string
- The description of the distribution configuration.
- Name string
- The name of the distribution configuration.
- Dictionary<string, string>
- The tags associated with the component.
- Distributions
[]Distribution
Configuration Distribution Args - The distributions of the distribution configuration.
- Description string
- The description of the distribution configuration.
- Name string
- The name of the distribution configuration.
- map[string]string
- The tags associated with the component.
- distributions
List<Distribution
Configuration Distribution> - The distributions of the distribution configuration.
- description String
- The description of the distribution configuration.
- name String
- The name of the distribution configuration.
- Map<String,String>
- The tags associated with the component.
- distributions
Distribution
Configuration Distribution[] - The distributions of the distribution configuration.
- description string
- The description of the distribution configuration.
- name string
- The name of the distribution configuration.
- {[key: string]: string}
- The tags associated with the component.
- distributions
Sequence[Distribution
Configuration Distribution Args] - The distributions of the distribution configuration.
- description str
- The description of the distribution configuration.
- name str
- The name of the distribution configuration.
- Mapping[str, str]
- The tags associated with the component.
- distributions List<Property Map>
- The distributions of the distribution configuration.
- description String
- The description of the distribution configuration.
- name String
- The name of the distribution configuration.
- Map<String>
- The tags associated with the component.
Outputs
All input properties are implicitly available as output properties. Additionally, the DistributionConfiguration resource produces the following output properties:
Supporting Types
DistributionConfigurationAmiDistributionConfiguration, DistributionConfigurationAmiDistributionConfigurationArgs
- Dictionary<string, string>
- The tags to apply to AMIs distributed to this Region.
- Description string
- The description of the AMI distribution configuration.
- Kms
Key stringId - The KMS key identifier used to encrypt the distributed image.
- Launch
Permission Pulumi.Configuration Aws Native. Image Builder. Inputs. Distribution Configuration Launch Permission Configuration - Launch permissions can be used to configure which AWS account s can use the AMI to launch instances.
- Name string
- The name of the AMI distribution configuration.
- Target
Account List<string>Ids - The ID of accounts to which you want to distribute an image.
- map[string]string
- The tags to apply to AMIs distributed to this Region.
- Description string
- The description of the AMI distribution configuration.
- Kms
Key stringId - The KMS key identifier used to encrypt the distributed image.
- Launch
Permission DistributionConfiguration Configuration Launch Permission Configuration - Launch permissions can be used to configure which AWS account s can use the AMI to launch instances.
- Name string
- The name of the AMI distribution configuration.
- Target
Account []stringIds - The ID of accounts to which you want to distribute an image.
- Map<String,String>
- The tags to apply to AMIs distributed to this Region.
- description String
- The description of the AMI distribution configuration.
- kms
Key StringId - The KMS key identifier used to encrypt the distributed image.
- launch
Permission DistributionConfiguration Configuration Launch Permission Configuration - Launch permissions can be used to configure which AWS account s can use the AMI to launch instances.
- name String
- The name of the AMI distribution configuration.
- target
Account List<String>Ids - The ID of accounts to which you want to distribute an image.
- {[key: string]: string}
- The tags to apply to AMIs distributed to this Region.
- description string
- The description of the AMI distribution configuration.
- kms
Key stringId - The KMS key identifier used to encrypt the distributed image.
- launch
Permission DistributionConfiguration Configuration Launch Permission Configuration - Launch permissions can be used to configure which AWS account s can use the AMI to launch instances.
- name string
- The name of the AMI distribution configuration.
- target
Account string[]Ids - The ID of accounts to which you want to distribute an image.
- Mapping[str, str]
- The tags to apply to AMIs distributed to this Region.
- description str
- The description of the AMI distribution configuration.
- kms_
key_ strid - The KMS key identifier used to encrypt the distributed image.
- launch_
permission_ Distributionconfiguration Configuration Launch Permission Configuration - Launch permissions can be used to configure which AWS account s can use the AMI to launch instances.
- name str
- The name of the AMI distribution configuration.
- target_
account_ Sequence[str]ids - The ID of accounts to which you want to distribute an image.
- Map<String>
- The tags to apply to AMIs distributed to this Region.
- description String
- The description of the AMI distribution configuration.
- kms
Key StringId - The KMS key identifier used to encrypt the distributed image.
- launch
Permission Property MapConfiguration - Launch permissions can be used to configure which AWS account s can use the AMI to launch instances.
- name String
- The name of the AMI distribution configuration.
- target
Account List<String>Ids - The ID of accounts to which you want to distribute an image.
DistributionConfigurationContainerDistributionConfiguration, DistributionConfigurationContainerDistributionConfigurationArgs
- List<string>
- Tags that are attached to the container distribution configuration.
- Description string
- The description of the container distribution configuration.
- Target
Repository Pulumi.Aws Native. Image Builder. Inputs. Distribution Configuration Target Container Repository - The destination repository for the container distribution configuration.
- []string
- Tags that are attached to the container distribution configuration.
- Description string
- The description of the container distribution configuration.
- Target
Repository DistributionConfiguration Target Container Repository - The destination repository for the container distribution configuration.
- List<String>
- Tags that are attached to the container distribution configuration.
- description String
- The description of the container distribution configuration.
- target
Repository DistributionConfiguration Target Container Repository - The destination repository for the container distribution configuration.
- string[]
- Tags that are attached to the container distribution configuration.
- description string
- The description of the container distribution configuration.
- target
Repository DistributionConfiguration Target Container Repository - The destination repository for the container distribution configuration.
- Sequence[str]
- Tags that are attached to the container distribution configuration.
- description str
- The description of the container distribution configuration.
- target_
repository DistributionConfiguration Target Container Repository - The destination repository for the container distribution configuration.
- List<String>
- Tags that are attached to the container distribution configuration.
- description String
- The description of the container distribution configuration.
- target
Repository Property Map - The destination repository for the container distribution configuration.
DistributionConfigurationDistribution, DistributionConfigurationDistributionArgs
- Region string
- region
- Ami
Distribution Pulumi.Configuration Aws Native. Image Builder. Inputs. Distribution Configuration Ami Distribution Configuration - The specific AMI settings, such as launch permissions and AMI tags. For details, see example schema below.
- Container
Distribution Pulumi.Configuration Aws Native. Image Builder. Inputs. Distribution Configuration Container Distribution Configuration - Container distribution settings for encryption, licensing, and sharing in a specific Region. For details, see example schema below.
- Fast
Launch List<Pulumi.Configurations Aws Native. Image Builder. Inputs. Distribution Configuration Fast Launch Configuration> - The Windows faster-launching configurations to use for AMI distribution.
- Launch
Template List<Pulumi.Configurations Aws Native. Image Builder. Inputs. Distribution Configuration Launch Template Configuration> - A group of launchTemplateConfiguration settings that apply to image distribution.
- License
Configuration List<string>Arns - The License Manager Configuration to associate with the AMI in the specified Region.
- Region string
- region
- Ami
Distribution DistributionConfiguration Configuration Ami Distribution Configuration - The specific AMI settings, such as launch permissions and AMI tags. For details, see example schema below.
- Container
Distribution DistributionConfiguration Configuration Container Distribution Configuration - Container distribution settings for encryption, licensing, and sharing in a specific Region. For details, see example schema below.
- Fast
Launch []DistributionConfigurations Configuration Fast Launch Configuration - The Windows faster-launching configurations to use for AMI distribution.
- Launch
Template []DistributionConfigurations Configuration Launch Template Configuration - A group of launchTemplateConfiguration settings that apply to image distribution.
- License
Configuration []stringArns - The License Manager Configuration to associate with the AMI in the specified Region.
- region String
- region
- ami
Distribution DistributionConfiguration Configuration Ami Distribution Configuration - The specific AMI settings, such as launch permissions and AMI tags. For details, see example schema below.
- container
Distribution DistributionConfiguration Configuration Container Distribution Configuration - Container distribution settings for encryption, licensing, and sharing in a specific Region. For details, see example schema below.
- fast
Launch List<DistributionConfigurations Configuration Fast Launch Configuration> - The Windows faster-launching configurations to use for AMI distribution.
- launch
Template List<DistributionConfigurations Configuration Launch Template Configuration> - A group of launchTemplateConfiguration settings that apply to image distribution.
- license
Configuration List<String>Arns - The License Manager Configuration to associate with the AMI in the specified Region.
- region string
- region
- ami
Distribution DistributionConfiguration Configuration Ami Distribution Configuration - The specific AMI settings, such as launch permissions and AMI tags. For details, see example schema below.
- container
Distribution DistributionConfiguration Configuration Container Distribution Configuration - Container distribution settings for encryption, licensing, and sharing in a specific Region. For details, see example schema below.
- fast
Launch DistributionConfigurations Configuration Fast Launch Configuration[] - The Windows faster-launching configurations to use for AMI distribution.
- launch
Template DistributionConfigurations Configuration Launch Template Configuration[] - A group of launchTemplateConfiguration settings that apply to image distribution.
- license
Configuration string[]Arns - The License Manager Configuration to associate with the AMI in the specified Region.
- region str
- region
- ami_
distribution_ Distributionconfiguration Configuration Ami Distribution Configuration - The specific AMI settings, such as launch permissions and AMI tags. For details, see example schema below.
- container_
distribution_ Distributionconfiguration Configuration Container Distribution Configuration - Container distribution settings for encryption, licensing, and sharing in a specific Region. For details, see example schema below.
- fast_
launch_ Sequence[Distributionconfigurations Configuration Fast Launch Configuration] - The Windows faster-launching configurations to use for AMI distribution.
- launch_
template_ Sequence[Distributionconfigurations Configuration Launch Template Configuration] - A group of launchTemplateConfiguration settings that apply to image distribution.
- license_
configuration_ Sequence[str]arns - The License Manager Configuration to associate with the AMI in the specified Region.
- region String
- region
- ami
Distribution Property MapConfiguration - The specific AMI settings, such as launch permissions and AMI tags. For details, see example schema below.
- container
Distribution Property MapConfiguration - Container distribution settings for encryption, licensing, and sharing in a specific Region. For details, see example schema below.
- fast
Launch List<Property Map>Configurations - The Windows faster-launching configurations to use for AMI distribution.
- launch
Template List<Property Map>Configurations - A group of launchTemplateConfiguration settings that apply to image distribution.
- license
Configuration List<String>Arns - The License Manager Configuration to associate with the AMI in the specified Region.
DistributionConfigurationFastLaunchConfiguration, DistributionConfigurationFastLaunchConfigurationArgs
- Account
Id string - The owner account ID for the fast-launch enabled Windows AMI.
- Enabled bool
- A Boolean that represents the current state of faster launching for the Windows AMI. Set to true to start using Windows faster launching, or false to stop using it.
- Launch
Template Pulumi.Aws Native. Image Builder. Inputs. Distribution Configuration Fast Launch Launch Template Specification - The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.
- Max
Parallel intLaunches - The maximum number of parallel instances that are launched for creating resources.
- Snapshot
Configuration Pulumi.Aws Native. Image Builder. Inputs. Distribution Configuration Fast Launch Snapshot Configuration - Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.
- Account
Id string - The owner account ID for the fast-launch enabled Windows AMI.
- Enabled bool
- A Boolean that represents the current state of faster launching for the Windows AMI. Set to true to start using Windows faster launching, or false to stop using it.
- Launch
Template DistributionConfiguration Fast Launch Launch Template Specification - The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.
- Max
Parallel intLaunches - The maximum number of parallel instances that are launched for creating resources.
- Snapshot
Configuration DistributionConfiguration Fast Launch Snapshot Configuration - Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.
- account
Id String - The owner account ID for the fast-launch enabled Windows AMI.
- enabled Boolean
- A Boolean that represents the current state of faster launching for the Windows AMI. Set to true to start using Windows faster launching, or false to stop using it.
- launch
Template DistributionConfiguration Fast Launch Launch Template Specification - The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.
- max
Parallel IntegerLaunches - The maximum number of parallel instances that are launched for creating resources.
- snapshot
Configuration DistributionConfiguration Fast Launch Snapshot Configuration - Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.
- account
Id string - The owner account ID for the fast-launch enabled Windows AMI.
- enabled boolean
- A Boolean that represents the current state of faster launching for the Windows AMI. Set to true to start using Windows faster launching, or false to stop using it.
- launch
Template DistributionConfiguration Fast Launch Launch Template Specification - The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.
- max
Parallel numberLaunches - The maximum number of parallel instances that are launched for creating resources.
- snapshot
Configuration DistributionConfiguration Fast Launch Snapshot Configuration - Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.
- account_
id str - The owner account ID for the fast-launch enabled Windows AMI.
- enabled bool
- A Boolean that represents the current state of faster launching for the Windows AMI. Set to true to start using Windows faster launching, or false to stop using it.
- launch_
template DistributionConfiguration Fast Launch Launch Template Specification - The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.
- max_
parallel_ intlaunches - The maximum number of parallel instances that are launched for creating resources.
- snapshot_
configuration DistributionConfiguration Fast Launch Snapshot Configuration - Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.
- account
Id String - The owner account ID for the fast-launch enabled Windows AMI.
- enabled Boolean
- A Boolean that represents the current state of faster launching for the Windows AMI. Set to true to start using Windows faster launching, or false to stop using it.
- launch
Template Property Map - The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.
- max
Parallel NumberLaunches - The maximum number of parallel instances that are launched for creating resources.
- snapshot
Configuration Property Map - Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.
DistributionConfigurationFastLaunchLaunchTemplateSpecification, DistributionConfigurationFastLaunchLaunchTemplateSpecificationArgs
- Launch
Template stringId - The ID of the launch template to use for faster launching for a Windows AMI.
- Launch
Template stringName - The name of the launch template to use for faster launching for a Windows AMI.
- Launch
Template stringVersion - The version of the launch template to use for faster launching for a Windows AMI.
- Launch
Template stringId - The ID of the launch template to use for faster launching for a Windows AMI.
- Launch
Template stringName - The name of the launch template to use for faster launching for a Windows AMI.
- Launch
Template stringVersion - The version of the launch template to use for faster launching for a Windows AMI.
- launch
Template StringId - The ID of the launch template to use for faster launching for a Windows AMI.
- launch
Template StringName - The name of the launch template to use for faster launching for a Windows AMI.
- launch
Template StringVersion - The version of the launch template to use for faster launching for a Windows AMI.
- launch
Template stringId - The ID of the launch template to use for faster launching for a Windows AMI.
- launch
Template stringName - The name of the launch template to use for faster launching for a Windows AMI.
- launch
Template stringVersion - The version of the launch template to use for faster launching for a Windows AMI.
- launch_
template_ strid - The ID of the launch template to use for faster launching for a Windows AMI.
- launch_
template_ strname - The name of the launch template to use for faster launching for a Windows AMI.
- launch_
template_ strversion - The version of the launch template to use for faster launching for a Windows AMI.
- launch
Template StringId - The ID of the launch template to use for faster launching for a Windows AMI.
- launch
Template StringName - The name of the launch template to use for faster launching for a Windows AMI.
- launch
Template StringVersion - The version of the launch template to use for faster launching for a Windows AMI.
DistributionConfigurationFastLaunchSnapshotConfiguration, DistributionConfigurationFastLaunchSnapshotConfigurationArgs
- Target
Resource intCount - The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.
- Target
Resource intCount - The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.
- target
Resource IntegerCount - The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.
- target
Resource numberCount - The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.
- target_
resource_ intcount - The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.
- target
Resource NumberCount - The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.
DistributionConfigurationLaunchPermissionConfiguration, DistributionConfigurationLaunchPermissionConfigurationArgs
- Organization
Arns List<string> - The ARN for an Amazon Web Services Organization that you want to share your AMI with.
- Organizational
Unit List<string>Arns - The ARN for an Organizations organizational unit (OU) that you want to share your AMI with.
- User
Groups List<string> - The name of the group.
- User
Ids List<string> - The AWS account ID.
- Organization
Arns []string - The ARN for an Amazon Web Services Organization that you want to share your AMI with.
- Organizational
Unit []stringArns - The ARN for an Organizations organizational unit (OU) that you want to share your AMI with.
- User
Groups []string - The name of the group.
- User
Ids []string - The AWS account ID.
- organization
Arns List<String> - The ARN for an Amazon Web Services Organization that you want to share your AMI with.
- organizational
Unit List<String>Arns - The ARN for an Organizations organizational unit (OU) that you want to share your AMI with.
- user
Groups List<String> - The name of the group.
- user
Ids List<String> - The AWS account ID.
- organization
Arns string[] - The ARN for an Amazon Web Services Organization that you want to share your AMI with.
- organizational
Unit string[]Arns - The ARN for an Organizations organizational unit (OU) that you want to share your AMI with.
- user
Groups string[] - The name of the group.
- user
Ids string[] - The AWS account ID.
- organization_
arns Sequence[str] - The ARN for an Amazon Web Services Organization that you want to share your AMI with.
- organizational_
unit_ Sequence[str]arns - The ARN for an Organizations organizational unit (OU) that you want to share your AMI with.
- user_
groups Sequence[str] - The name of the group.
- user_
ids Sequence[str] - The AWS account ID.
- organization
Arns List<String> - The ARN for an Amazon Web Services Organization that you want to share your AMI with.
- organizational
Unit List<String>Arns - The ARN for an Organizations organizational unit (OU) that you want to share your AMI with.
- user
Groups List<String> - The name of the group.
- user
Ids List<String> - The AWS account ID.
DistributionConfigurationLaunchTemplateConfiguration, DistributionConfigurationLaunchTemplateConfigurationArgs
- Account
Id string - The account ID that this configuration applies to.
- Launch
Template stringId - Identifies the EC2 launch template to use.
- Set
Default boolVersion - Set the specified EC2 launch template as the default launch template for the specified account.
- Account
Id string - The account ID that this configuration applies to.
- Launch
Template stringId - Identifies the EC2 launch template to use.
- Set
Default boolVersion - Set the specified EC2 launch template as the default launch template for the specified account.
- account
Id String - The account ID that this configuration applies to.
- launch
Template StringId - Identifies the EC2 launch template to use.
- set
Default BooleanVersion - Set the specified EC2 launch template as the default launch template for the specified account.
- account
Id string - The account ID that this configuration applies to.
- launch
Template stringId - Identifies the EC2 launch template to use.
- set
Default booleanVersion - Set the specified EC2 launch template as the default launch template for the specified account.
- account_
id str - The account ID that this configuration applies to.
- launch_
template_ strid - Identifies the EC2 launch template to use.
- set_
default_ boolversion - Set the specified EC2 launch template as the default launch template for the specified account.
- account
Id String - The account ID that this configuration applies to.
- launch
Template StringId - Identifies the EC2 launch template to use.
- set
Default BooleanVersion - Set the specified EC2 launch template as the default launch template for the specified account.
DistributionConfigurationTargetContainerRepository, DistributionConfigurationTargetContainerRepositoryArgs
- Repository
Name string - The repository name of target container repository.
- Service
Pulumi.
Aws Native. Image Builder. Distribution Configuration Target Container Repository Service - The service of target container repository.
- Repository
Name string - The repository name of target container repository.
- Service
Distribution
Configuration Target Container Repository Service - The service of target container repository.
- repository
Name String - The repository name of target container repository.
- service
Distribution
Configuration Target Container Repository Service - The service of target container repository.
- repository
Name string - The repository name of target container repository.
- service
Distribution
Configuration Target Container Repository Service - The service of target container repository.
- repository_
name str - The repository name of target container repository.
- service
Distribution
Configuration Target Container Repository Service - The service of target container repository.
- repository
Name String - The repository name of target container repository.
- service "ECR"
- The service of target container repository.
DistributionConfigurationTargetContainerRepositoryService, DistributionConfigurationTargetContainerRepositoryServiceArgs
- Ecr
- ECR
- Distribution
Configuration Target Container Repository Service Ecr - ECR
- Ecr
- ECR
- Ecr
- ECR
- ECR
- ECR
- "ECR"
- ECR
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.