1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. imagebuilder
  5. getDistributionConfiguration

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.imagebuilder.getDistributionConfiguration

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

Resource schema for AWS::ImageBuilder::DistributionConfiguration

Using getDistributionConfiguration

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 getDistributionConfiguration(args: GetDistributionConfigurationArgs, opts?: InvokeOptions): Promise<GetDistributionConfigurationResult>
function getDistributionConfigurationOutput(args: GetDistributionConfigurationOutputArgs, opts?: InvokeOptions): Output<GetDistributionConfigurationResult>
Copy
def get_distribution_configuration(arn: Optional[str] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetDistributionConfigurationResult
def get_distribution_configuration_output(arn: Optional[pulumi.Input[str]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetDistributionConfigurationResult]
Copy
func LookupDistributionConfiguration(ctx *Context, args *LookupDistributionConfigurationArgs, opts ...InvokeOption) (*LookupDistributionConfigurationResult, error)
func LookupDistributionConfigurationOutput(ctx *Context, args *LookupDistributionConfigurationOutputArgs, opts ...InvokeOption) LookupDistributionConfigurationResultOutput
Copy

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

public static class GetDistributionConfiguration 
{
    public static Task<GetDistributionConfigurationResult> InvokeAsync(GetDistributionConfigurationArgs args, InvokeOptions? opts = null)
    public static Output<GetDistributionConfigurationResult> Invoke(GetDistributionConfigurationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDistributionConfigurationResult> getDistributionConfiguration(GetDistributionConfigurationArgs args, InvokeOptions options)
public static Output<GetDistributionConfigurationResult> getDistributionConfiguration(GetDistributionConfigurationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:imagebuilder:getDistributionConfiguration
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Arn This property is required. string
The Amazon Resource Name (ARN) of the distribution configuration.
Arn This property is required. string
The Amazon Resource Name (ARN) of the distribution configuration.
arn This property is required. String
The Amazon Resource Name (ARN) of the distribution configuration.
arn This property is required. string
The Amazon Resource Name (ARN) of the distribution configuration.
arn This property is required. str
The Amazon Resource Name (ARN) of the distribution configuration.
arn This property is required. String
The Amazon Resource Name (ARN) of the distribution configuration.

getDistributionConfiguration Result

The following output properties are available:

Arn string
The Amazon Resource Name (ARN) of the distribution configuration.
Description string
The description of the distribution configuration.
Distributions List<Pulumi.AwsNative.ImageBuilder.Outputs.DistributionConfigurationDistribution>
The distributions of the distribution configuration.
Tags Dictionary<string, string>
The tags associated with the component.
Arn string
The Amazon Resource Name (ARN) of the distribution configuration.
Description string
The description of the distribution configuration.
Distributions []DistributionConfigurationDistribution
The distributions of the distribution configuration.
Tags map[string]string
The tags associated with the component.
arn String
The Amazon Resource Name (ARN) of the distribution configuration.
description String
The description of the distribution configuration.
distributions List<DistributionConfigurationDistribution>
The distributions of the distribution configuration.
tags Map<String,String>
The tags associated with the component.
arn string
The Amazon Resource Name (ARN) of the distribution configuration.
description string
The description of the distribution configuration.
distributions DistributionConfigurationDistribution[]
The distributions of the distribution configuration.
tags {[key: string]: string}
The tags associated with the component.
arn str
The Amazon Resource Name (ARN) of the distribution configuration.
description str
The description of the distribution configuration.
distributions Sequence[DistributionConfigurationDistribution]
The distributions of the distribution configuration.
tags Mapping[str, str]
The tags associated with the component.
arn String
The Amazon Resource Name (ARN) of the distribution configuration.
description String
The description of the distribution configuration.
distributions List<Property Map>
The distributions of the distribution configuration.
tags Map<String>
The tags associated with the component.

Supporting Types

DistributionConfigurationAmiDistributionConfiguration

AmiTags Dictionary<string, string>
The tags to apply to AMIs distributed to this Region.
Description string
The description of the AMI distribution configuration.
KmsKeyId string
The KMS key identifier used to encrypt the distributed image.
LaunchPermissionConfiguration Pulumi.AwsNative.ImageBuilder.Inputs.DistributionConfigurationLaunchPermissionConfiguration
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.
TargetAccountIds List<string>
The ID of accounts to which you want to distribute an image.
AmiTags map[string]string
The tags to apply to AMIs distributed to this Region.
Description string
The description of the AMI distribution configuration.
KmsKeyId string
The KMS key identifier used to encrypt the distributed image.
LaunchPermissionConfiguration DistributionConfigurationLaunchPermissionConfiguration
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.
TargetAccountIds []string
The ID of accounts to which you want to distribute an image.
amiTags Map<String,String>
The tags to apply to AMIs distributed to this Region.
description String
The description of the AMI distribution configuration.
kmsKeyId String
The KMS key identifier used to encrypt the distributed image.
launchPermissionConfiguration DistributionConfigurationLaunchPermissionConfiguration
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.
targetAccountIds List<String>
The ID of accounts to which you want to distribute an image.
amiTags {[key: string]: string}
The tags to apply to AMIs distributed to this Region.
description string
The description of the AMI distribution configuration.
kmsKeyId string
The KMS key identifier used to encrypt the distributed image.
launchPermissionConfiguration DistributionConfigurationLaunchPermissionConfiguration
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.
targetAccountIds string[]
The ID of accounts to which you want to distribute an image.
ami_tags Mapping[str, str]
The tags to apply to AMIs distributed to this Region.
description str
The description of the AMI distribution configuration.
kms_key_id str
The KMS key identifier used to encrypt the distributed image.
launch_permission_configuration DistributionConfigurationLaunchPermissionConfiguration
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_ids Sequence[str]
The ID of accounts to which you want to distribute an image.
amiTags Map<String>
The tags to apply to AMIs distributed to this Region.
description String
The description of the AMI distribution configuration.
kmsKeyId String
The KMS key identifier used to encrypt the distributed image.
launchPermissionConfiguration Property Map
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.
targetAccountIds List<String>
The ID of accounts to which you want to distribute an image.

DistributionConfigurationContainerDistributionConfiguration

ContainerTags List<string>
Tags that are attached to the container distribution configuration.
Description string
The description of the container distribution configuration.
TargetRepository Pulumi.AwsNative.ImageBuilder.Inputs.DistributionConfigurationTargetContainerRepository
The destination repository for the container distribution configuration.
ContainerTags []string
Tags that are attached to the container distribution configuration.
Description string
The description of the container distribution configuration.
TargetRepository DistributionConfigurationTargetContainerRepository
The destination repository for the container distribution configuration.
containerTags List<String>
Tags that are attached to the container distribution configuration.
description String
The description of the container distribution configuration.
targetRepository DistributionConfigurationTargetContainerRepository
The destination repository for the container distribution configuration.
containerTags string[]
Tags that are attached to the container distribution configuration.
description string
The description of the container distribution configuration.
targetRepository DistributionConfigurationTargetContainerRepository
The destination repository for the container distribution configuration.
container_tags Sequence[str]
Tags that are attached to the container distribution configuration.
description str
The description of the container distribution configuration.
target_repository DistributionConfigurationTargetContainerRepository
The destination repository for the container distribution configuration.
containerTags List<String>
Tags that are attached to the container distribution configuration.
description String
The description of the container distribution configuration.
targetRepository Property Map
The destination repository for the container distribution configuration.

DistributionConfigurationDistribution

Region This property is required. string
region
AmiDistributionConfiguration Pulumi.AwsNative.ImageBuilder.Inputs.DistributionConfigurationAmiDistributionConfiguration
The specific AMI settings, such as launch permissions and AMI tags. For details, see example schema below.
ContainerDistributionConfiguration Pulumi.AwsNative.ImageBuilder.Inputs.DistributionConfigurationContainerDistributionConfiguration
Container distribution settings for encryption, licensing, and sharing in a specific Region. For details, see example schema below.
FastLaunchConfigurations List<Pulumi.AwsNative.ImageBuilder.Inputs.DistributionConfigurationFastLaunchConfiguration>
The Windows faster-launching configurations to use for AMI distribution.
LaunchTemplateConfigurations List<Pulumi.AwsNative.ImageBuilder.Inputs.DistributionConfigurationLaunchTemplateConfiguration>
A group of launchTemplateConfiguration settings that apply to image distribution.
LicenseConfigurationArns List<string>
The License Manager Configuration to associate with the AMI in the specified Region.
Region This property is required. string
region
AmiDistributionConfiguration DistributionConfigurationAmiDistributionConfiguration
The specific AMI settings, such as launch permissions and AMI tags. For details, see example schema below.
ContainerDistributionConfiguration DistributionConfigurationContainerDistributionConfiguration
Container distribution settings for encryption, licensing, and sharing in a specific Region. For details, see example schema below.
FastLaunchConfigurations []DistributionConfigurationFastLaunchConfiguration
The Windows faster-launching configurations to use for AMI distribution.
LaunchTemplateConfigurations []DistributionConfigurationLaunchTemplateConfiguration
A group of launchTemplateConfiguration settings that apply to image distribution.
LicenseConfigurationArns []string
The License Manager Configuration to associate with the AMI in the specified Region.
region This property is required. String
region
amiDistributionConfiguration DistributionConfigurationAmiDistributionConfiguration
The specific AMI settings, such as launch permissions and AMI tags. For details, see example schema below.
containerDistributionConfiguration DistributionConfigurationContainerDistributionConfiguration
Container distribution settings for encryption, licensing, and sharing in a specific Region. For details, see example schema below.
fastLaunchConfigurations List<DistributionConfigurationFastLaunchConfiguration>
The Windows faster-launching configurations to use for AMI distribution.
launchTemplateConfigurations List<DistributionConfigurationLaunchTemplateConfiguration>
A group of launchTemplateConfiguration settings that apply to image distribution.
licenseConfigurationArns List<String>
The License Manager Configuration to associate with the AMI in the specified Region.
region This property is required. string
region
amiDistributionConfiguration DistributionConfigurationAmiDistributionConfiguration
The specific AMI settings, such as launch permissions and AMI tags. For details, see example schema below.
containerDistributionConfiguration DistributionConfigurationContainerDistributionConfiguration
Container distribution settings for encryption, licensing, and sharing in a specific Region. For details, see example schema below.
fastLaunchConfigurations DistributionConfigurationFastLaunchConfiguration[]
The Windows faster-launching configurations to use for AMI distribution.
launchTemplateConfigurations DistributionConfigurationLaunchTemplateConfiguration[]
A group of launchTemplateConfiguration settings that apply to image distribution.
licenseConfigurationArns string[]
The License Manager Configuration to associate with the AMI in the specified Region.
region This property is required. str
region
ami_distribution_configuration DistributionConfigurationAmiDistributionConfiguration
The specific AMI settings, such as launch permissions and AMI tags. For details, see example schema below.
container_distribution_configuration DistributionConfigurationContainerDistributionConfiguration
Container distribution settings for encryption, licensing, and sharing in a specific Region. For details, see example schema below.
fast_launch_configurations Sequence[DistributionConfigurationFastLaunchConfiguration]
The Windows faster-launching configurations to use for AMI distribution.
launch_template_configurations Sequence[DistributionConfigurationLaunchTemplateConfiguration]
A group of launchTemplateConfiguration settings that apply to image distribution.
license_configuration_arns Sequence[str]
The License Manager Configuration to associate with the AMI in the specified Region.
region This property is required. String
region
amiDistributionConfiguration Property Map
The specific AMI settings, such as launch permissions and AMI tags. For details, see example schema below.
containerDistributionConfiguration Property Map
Container distribution settings for encryption, licensing, and sharing in a specific Region. For details, see example schema below.
fastLaunchConfigurations List<Property Map>
The Windows faster-launching configurations to use for AMI distribution.
launchTemplateConfigurations List<Property Map>
A group of launchTemplateConfiguration settings that apply to image distribution.
licenseConfigurationArns List<String>
The License Manager Configuration to associate with the AMI in the specified Region.

DistributionConfigurationFastLaunchConfiguration

AccountId 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.
LaunchTemplate Pulumi.AwsNative.ImageBuilder.Inputs.DistributionConfigurationFastLaunchLaunchTemplateSpecification
The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.
MaxParallelLaunches int
The maximum number of parallel instances that are launched for creating resources.
SnapshotConfiguration Pulumi.AwsNative.ImageBuilder.Inputs.DistributionConfigurationFastLaunchSnapshotConfiguration
Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.
AccountId 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.
LaunchTemplate DistributionConfigurationFastLaunchLaunchTemplateSpecification
The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.
MaxParallelLaunches int
The maximum number of parallel instances that are launched for creating resources.
SnapshotConfiguration DistributionConfigurationFastLaunchSnapshotConfiguration
Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.
accountId 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.
launchTemplate DistributionConfigurationFastLaunchLaunchTemplateSpecification
The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.
maxParallelLaunches Integer
The maximum number of parallel instances that are launched for creating resources.
snapshotConfiguration DistributionConfigurationFastLaunchSnapshotConfiguration
Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.
accountId 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.
launchTemplate DistributionConfigurationFastLaunchLaunchTemplateSpecification
The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.
maxParallelLaunches number
The maximum number of parallel instances that are launched for creating resources.
snapshotConfiguration DistributionConfigurationFastLaunchSnapshotConfiguration
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 DistributionConfigurationFastLaunchLaunchTemplateSpecification
The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.
max_parallel_launches int
The maximum number of parallel instances that are launched for creating resources.
snapshot_configuration DistributionConfigurationFastLaunchSnapshotConfiguration
Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.
accountId 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.
launchTemplate Property Map
The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.
maxParallelLaunches Number
The maximum number of parallel instances that are launched for creating resources.
snapshotConfiguration 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

LaunchTemplateId string
The ID of the launch template to use for faster launching for a Windows AMI.
LaunchTemplateName string
The name of the launch template to use for faster launching for a Windows AMI.
LaunchTemplateVersion string
The version of the launch template to use for faster launching for a Windows AMI.
LaunchTemplateId string
The ID of the launch template to use for faster launching for a Windows AMI.
LaunchTemplateName string
The name of the launch template to use for faster launching for a Windows AMI.
LaunchTemplateVersion string
The version of the launch template to use for faster launching for a Windows AMI.
launchTemplateId String
The ID of the launch template to use for faster launching for a Windows AMI.
launchTemplateName String
The name of the launch template to use for faster launching for a Windows AMI.
launchTemplateVersion String
The version of the launch template to use for faster launching for a Windows AMI.
launchTemplateId string
The ID of the launch template to use for faster launching for a Windows AMI.
launchTemplateName string
The name of the launch template to use for faster launching for a Windows AMI.
launchTemplateVersion string
The version of the launch template to use for faster launching for a Windows AMI.
launch_template_id str
The ID of the launch template to use for faster launching for a Windows AMI.
launch_template_name str
The name of the launch template to use for faster launching for a Windows AMI.
launch_template_version str
The version of the launch template to use for faster launching for a Windows AMI.
launchTemplateId String
The ID of the launch template to use for faster launching for a Windows AMI.
launchTemplateName String
The name of the launch template to use for faster launching for a Windows AMI.
launchTemplateVersion String
The version of the launch template to use for faster launching for a Windows AMI.

DistributionConfigurationFastLaunchSnapshotConfiguration

TargetResourceCount int
The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.
TargetResourceCount int
The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.
targetResourceCount Integer
The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.
targetResourceCount number
The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.
target_resource_count int
The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.
targetResourceCount Number
The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.

DistributionConfigurationLaunchPermissionConfiguration

OrganizationArns List<string>
The ARN for an Amazon Web Services Organization that you want to share your AMI with.
OrganizationalUnitArns List<string>
The ARN for an Organizations organizational unit (OU) that you want to share your AMI with.
UserGroups List<string>
The name of the group.
UserIds List<string>
The AWS account ID.
OrganizationArns []string
The ARN for an Amazon Web Services Organization that you want to share your AMI with.
OrganizationalUnitArns []string
The ARN for an Organizations organizational unit (OU) that you want to share your AMI with.
UserGroups []string
The name of the group.
UserIds []string
The AWS account ID.
organizationArns List<String>
The ARN for an Amazon Web Services Organization that you want to share your AMI with.
organizationalUnitArns List<String>
The ARN for an Organizations organizational unit (OU) that you want to share your AMI with.
userGroups List<String>
The name of the group.
userIds List<String>
The AWS account ID.
organizationArns string[]
The ARN for an Amazon Web Services Organization that you want to share your AMI with.
organizationalUnitArns string[]
The ARN for an Organizations organizational unit (OU) that you want to share your AMI with.
userGroups string[]
The name of the group.
userIds 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_arns Sequence[str]
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.
organizationArns List<String>
The ARN for an Amazon Web Services Organization that you want to share your AMI with.
organizationalUnitArns List<String>
The ARN for an Organizations organizational unit (OU) that you want to share your AMI with.
userGroups List<String>
The name of the group.
userIds List<String>
The AWS account ID.

DistributionConfigurationLaunchTemplateConfiguration

AccountId string
The account ID that this configuration applies to.
LaunchTemplateId string
Identifies the EC2 launch template to use.
SetDefaultVersion bool
Set the specified EC2 launch template as the default launch template for the specified account.
AccountId string
The account ID that this configuration applies to.
LaunchTemplateId string
Identifies the EC2 launch template to use.
SetDefaultVersion bool
Set the specified EC2 launch template as the default launch template for the specified account.
accountId String
The account ID that this configuration applies to.
launchTemplateId String
Identifies the EC2 launch template to use.
setDefaultVersion Boolean
Set the specified EC2 launch template as the default launch template for the specified account.
accountId string
The account ID that this configuration applies to.
launchTemplateId string
Identifies the EC2 launch template to use.
setDefaultVersion boolean
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_id str
Identifies the EC2 launch template to use.
set_default_version bool
Set the specified EC2 launch template as the default launch template for the specified account.
accountId String
The account ID that this configuration applies to.
launchTemplateId String
Identifies the EC2 launch template to use.
setDefaultVersion Boolean
Set the specified EC2 launch template as the default launch template for the specified account.

DistributionConfigurationTargetContainerRepository

RepositoryName string
The repository name of target container repository.
Service Pulumi.AwsNative.ImageBuilder.DistributionConfigurationTargetContainerRepositoryService
The service of target container repository.
RepositoryName string
The repository name of target container repository.
Service DistributionConfigurationTargetContainerRepositoryService
The service of target container repository.
repositoryName String
The repository name of target container repository.
service DistributionConfigurationTargetContainerRepositoryService
The service of target container repository.
repositoryName string
The repository name of target container repository.
service DistributionConfigurationTargetContainerRepositoryService
The service of target container repository.
repository_name str
The repository name of target container repository.
service DistributionConfigurationTargetContainerRepositoryService
The service of target container repository.
repositoryName String
The repository name of target container repository.
service "ECR"
The service of target container repository.

DistributionConfigurationTargetContainerRepositoryService

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi