Skip to content
AWS for Query.Farm

aws.imagebuilder.get_distribution_configuration

Example SQL Queries

SELECT * FROM
aws.imagebuilder.get_distribution_configuration
WHERE
"distribution_configuration_arn" = 'VALUE';

Description

Gets a distribution configuration.

Table Definition

Column NameColumn Data Type
distribution_configuration_arn Required Input Column

The Amazon Resource Name (ARN) of the distribution configuration that you want to retrieve.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

distribution_configuration

The distribution configuration object.

STRUCT(
    "arn" VARCHAR,
    "name" VARCHAR,
    "description" VARCHAR,
    "distributions" STRUCT(
        "region" VARCHAR,
        "ami_distribution_configuration" STRUCT(
            "name" VARCHAR,
            "description" VARCHAR,
            "target_account_ids" VARCHAR[],
            "ami_tags" MAP(VARCHAR, VARCHAR),
            "kms_key_id" VARCHAR,
            "launch_permission" STRUCT(
                "user_ids" VARCHAR[],
                "user_groups" VARCHAR[],
                "organization_arns" VARCHAR[],
                "organizational_unit_arns" VARCHAR[]
            )
        ),
        "container_distribution_configuration" STRUCT(
            "description" VARCHAR,
            "container_tags" VARCHAR[],
            "target_repository" STRUCT(
                "service" VARCHAR,
                "repository_name" VARCHAR
            )
        ),
        "license_configuration_arns" VARCHAR[],
        "launch_template_configurations" STRUCT(
            "launch_template_id" VARCHAR,
            "account_id" VARCHAR,
            "set_default_version" BOOLEAN
        )[],
        "s3_export_configuration" STRUCT(
            "role_name" VARCHAR,
            "disk_image_format" VARCHAR,
            "s3_bucket" VARCHAR,
            "s3_prefix" VARCHAR
        ),
        "fast_launch_configurations" STRUCT(
            "enabled" BOOLEAN,
            "snapshot_configuration" STRUCT(
                "target_resource_count" BIGINT
            ),
            "max_parallel_launches" BIGINT,
            "launch_template" STRUCT(
                "launch_template_id" VARCHAR,
                "launch_template_name" VARCHAR,
                "launch_template_version" VARCHAR
            ),
            "account_id" VARCHAR
        )[]
    )[],
    "timeout_minutes" BIGINT,
    "date_created" VARCHAR,
    "date_updated" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR)
)
Show child fields
distribution_configuration.arn

The Amazon Resource Name (ARN) of the distribution configuration.

distribution_configuration.date_created

The date on which this distribution configuration was created.

distribution_configuration.date_updated

The date on which this distribution configuration was last updated.

distribution_configuration.description

The description of the distribution configuration.

distribution_configuration.distributions[]
Show child fields
distribution_configuration.distributions[].ami_distribution_configuration

The specific AMI settings; for example, launch permissions or AMI tags.

Show child fields
distribution_configuration.distributions[].ami_distribution_configuration.ami_tags

The tags to apply to AMIs distributed to this Region.

distribution_configuration.distributions[].ami_distribution_configuration.description

The description of the AMI distribution configuration. Minimum and maximum length are in characters.

distribution_configuration.distributions[].ami_distribution_configuration.kms_key_id

The KMS key identifier used to encrypt the distributed image.

distribution_configuration.distributions[].ami_distribution_configuration.launch_permission

Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.

Show child fields
distribution_configuration.distributions[].ami_distribution_configuration.launch_permission.organization_arns[]
distribution_configuration.distributions[].ami_distribution_configuration.launch_permission.organizational_unit_arns[]
distribution_configuration.distributions[].ami_distribution_configuration.launch_permission.user_groups[]
distribution_configuration.distributions[].ami_distribution_configuration.launch_permission.user_ids[]
distribution_configuration.distributions[].ami_distribution_configuration.name

The name of the output AMI.

distribution_configuration.distributions[].ami_distribution_configuration.target_account_ids[]
distribution_configuration.distributions[].container_distribution_configuration

Container distribution settings for encryption, licensing, and sharing in a specific Region.

Show child fields
distribution_configuration.distributions[].container_distribution_configuration.container_tags[]
distribution_configuration.distributions[].container_distribution_configuration.description

The description of the container distribution configuration.

distribution_configuration.distributions[].container_distribution_configuration.target_repository

The destination repository for the container distribution configuration.

Show child fields
distribution_configuration.distributions[].container_distribution_configuration.target_repository.repository_name

The name of the container repository where the output container image is stored. This name is prefixed by the repository location.

distribution_configuration.distributions[].container_distribution_configuration.target_repository.service

Specifies the service in which this image was registered.

distribution_configuration.distributions[].fast_launch_configurations[]
Show child fields
distribution_configuration.distributions[].fast_launch_configurations[].account_id

The owner account ID for the fast-launch enabled Windows AMI.

distribution_configuration.distributions[].fast_launch_configurations[].enabled

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.

distribution_configuration.distributions[].fast_launch_configurations[].launch_template

The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.

Show child fields
distribution_configuration.distributions[].fast_launch_configurations[].launch_template.launch_template_id

The ID of the launch template to use for faster launching for a Windows AMI.

distribution_configuration.distributions[].fast_launch_configurations[].launch_template.launch_template_name

The name of the launch template to use for faster launching for a Windows AMI.

distribution_configuration.distributions[].fast_launch_configurations[].launch_template.launch_template_version

The version of the launch template to use for faster launching for a Windows AMI.

distribution_configuration.distributions[].fast_launch_configurations[].max_parallel_launches

The maximum number of parallel instances that are launched for creating resources.

distribution_configuration.distributions[].fast_launch_configurations[].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.

Show child fields
distribution_configuration.distributions[].fast_launch_configurations[].snapshot_configuration.target_resource_count

The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.

distribution_configuration.distributions[].launch_template_configurations[]
Show child fields
distribution_configuration.distributions[].launch_template_configurations[].account_id

The account ID that this configuration applies to.

distribution_configuration.distributions[].launch_template_configurations[].launch_template_id

Identifies the Amazon EC2 launch template to use.

distribution_configuration.distributions[].launch_template_configurations[].set_default_version

Set the specified Amazon EC2 launch template as the default launch template for the specified account.

distribution_configuration.distributions[].license_configuration_arns[]
distribution_configuration.distributions[].region

The target Region.

distribution_configuration.distributions[].s3_export_configuration

Configure export settings to deliver disk images created from your image build, using a file format that is compatible with your VMs in that Region.

Show child fields
distribution_configuration.distributions[].s3_export_configuration.disk_image_format

Export the updated image to one of the following supported disk image formats:

  • Virtual Hard Disk (VHD) – Compatible with Citrix Xen and Microsoft Hyper-V virtualization products.

  • Stream-optimized ESX Virtual Machine Disk (VMDK) – Compatible with VMware ESX and VMware vSphere versions 4, 5, and 6.

  • Raw – Raw format.

distribution_configuration.distributions[].s3_export_configuration.role_name

The name of the role that grants VM Import/Export permission to export images to your S3 bucket.

distribution_configuration.distributions[].s3_export_configuration.s3_bucket

The S3 bucket in which to store the output disk images for your VM.

distribution_configuration.distributions[].s3_export_configuration.s3_prefix

The Amazon S3 path for the bucket where the output disk images for your VM are stored.

distribution_configuration.name

The name of the distribution configuration.

distribution_configuration.tags

The tags of the distribution configuration.

distribution_configuration.timeout_minutes

The maximum duration in minutes for this distribution configuration.

request_id

The request ID that uniquely identifies this request.

VARCHAR