Package-level declarations

Types

Link copied to clipboard
data class ContainerRecipeComponentConfiguration(val componentArn: String? = null, val parameters: List<ContainerRecipeComponentParameter>? = null)

Configuration details of the component.

Link copied to clipboard
data class ContainerRecipeComponentParameter(val name: String, val value: List<String>)

Contains a key/value pair that sets the named component parameter.

data class ContainerRecipeEbsInstanceBlockDeviceSpecification(val deleteOnTermination: Boolean? = null, val encrypted: Boolean? = null, val iops: Int? = null, val kmsKeyId: String? = null, val snapshotId: String? = null, val throughput: Int? = null, val volumeSize: Int? = null, val volumeType: ContainerRecipeEbsInstanceBlockDeviceSpecificationVolumeType? = null)

Amazon EBS-specific block device mapping specifications.

data class ContainerRecipeInstanceBlockDeviceMapping(val deviceName: String? = null, val ebs: ContainerRecipeEbsInstanceBlockDeviceSpecification? = null, val noDevice: String? = null, val virtualName: String? = null)

Defines block device mappings for the instance used to configure your image.

Link copied to clipboard
data class ContainerRecipeInstanceConfiguration(val blockDeviceMappings: List<ContainerRecipeInstanceBlockDeviceMapping>? = null, val image: String? = null)

A group of options that can be used to configure an instance for building and testing container images.

Link copied to clipboard
data class ContainerRecipeTargetContainerRepository(val repositoryName: String? = null, val service: ContainerRecipeTargetContainerRepositoryService? = null)

The container repository where the output container image is stored.

data class DistributionConfigurationAmiDistributionConfiguration(val amiTags: Map<String, String>? = null, val description: String? = null, val kmsKeyId: String? = null, val launchPermissionConfiguration: DistributionConfigurationLaunchPermissionConfiguration? = null, val name: String? = null, val targetAccountIds: List<String>? = null)

The specific AMI settings (for example, launch permissions, AMI tags).

data class DistributionConfigurationContainerDistributionConfiguration(val containerTags: List<String>? = null, val description: String? = null, val targetRepository: DistributionConfigurationTargetContainerRepository? = null)

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

Link copied to clipboard
data class DistributionConfigurationDistribution(val amiDistributionConfiguration: DistributionConfigurationAmiDistributionConfiguration? = null, val containerDistributionConfiguration: DistributionConfigurationContainerDistributionConfiguration? = null, val fastLaunchConfigurations: List<DistributionConfigurationFastLaunchConfiguration>? = null, val launchTemplateConfigurations: List<DistributionConfigurationLaunchTemplateConfiguration>? = null, val licenseConfigurationArns: List<String>? = null, val region: String, val ssmParameterConfigurations: List<DistributionConfigurationSsmParameterConfiguration>? = null)

The distributions of the distribution configuration.

data class DistributionConfigurationFastLaunchConfiguration(val accountId: String? = null, val enabled: Boolean? = null, val launchTemplate: DistributionConfigurationFastLaunchLaunchTemplateSpecification? = null, val maxParallelLaunches: Int? = null, val snapshotConfiguration: DistributionConfigurationFastLaunchSnapshotConfiguration? = null)

The Windows faster-launching configuration to use for AMI distribution.

data class DistributionConfigurationFastLaunchLaunchTemplateSpecification(val launchTemplateId: String? = null, val launchTemplateName: String? = null, val launchTemplateVersion: String? = null)

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

data class DistributionConfigurationFastLaunchSnapshotConfiguration(val targetResourceCount: Int? = null)

Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.

data class DistributionConfigurationLaunchPermissionConfiguration(val organizationArns: List<String>? = null, val organizationalUnitArns: List<String>? = null, val userGroups: List<String>? = null, val userIds: List<String>? = null)

Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances.

data class DistributionConfigurationLaunchTemplateConfiguration(val accountId: String? = null, val launchTemplateId: String? = null, val setDefaultVersion: Boolean? = null)

launchTemplateConfiguration settings that apply to image distribution.

data class DistributionConfigurationSsmParameterConfiguration(val amiAccountId: String? = null, val dataType: DistributionConfigurationSsmParameterConfigurationDataType? = null, val parameterName: String)

The SSM parameter configuration for AMI distribution.

The destination repository for the container image.

Link copied to clipboard
data class GetComponentResult(val arn: String? = null, val encrypted: Boolean? = null, val type: ComponentType? = null)
Link copied to clipboard
data class GetContainerRecipeResult(val arn: String? = null)
Link copied to clipboard
data class GetDistributionConfigurationResult(val arn: String? = null, val description: String? = null, val distributions: List<DistributionConfigurationDistribution>? = null, val tags: Map<String, String>? = null)
Link copied to clipboard
data class GetImagePipelineResult(val arn: String? = null, val containerRecipeArn: String? = null, val description: String? = null, val distributionConfigurationArn: String? = null, val enhancedImageMetadataEnabled: Boolean? = null, val executionRole: String? = null, val imageRecipeArn: String? = null, val imageScanningConfiguration: ImagePipelineImageScanningConfiguration? = null, val imageTestsConfiguration: ImagePipelineImageTestsConfiguration? = null, val infrastructureConfigurationArn: String? = null, val schedule: ImagePipelineSchedule? = null, val status: ImagePipelineStatus? = null, val tags: Map<String, String>? = null, val workflows: List<ImagePipelineWorkflowConfiguration>? = null)
Link copied to clipboard
data class GetImageRecipeResult(val additionalInstanceConfiguration: ImageRecipeAdditionalInstanceConfiguration? = null, val arn: String? = null)
Link copied to clipboard
data class GetImageResult(val arn: String? = null, val executionRole: String? = null, val imageId: String? = null, val imageUri: String? = null, val name: String? = null)
Link copied to clipboard
data class GetInfrastructureConfigurationResult(val arn: String? = null, val description: String? = null, val instanceMetadataOptions: InfrastructureConfigurationInstanceMetadataOptions? = null, val instanceProfileName: String? = null, val instanceTypes: List<String>? = null, val keyPair: String? = null, val logging: InfrastructureConfigurationLogging? = null, val placement: InfrastructureConfigurationPlacement? = null, val resourceTags: Map<String, String>? = null, val securityGroupIds: List<String>? = null, val snsTopicArn: String? = null, val subnetId: String? = null, val tags: Map<String, String>? = null, val terminateInstanceOnFailure: Boolean? = null)
Link copied to clipboard
data class GetLifecyclePolicyResult(val arn: String? = null, val description: String? = null, val executionRole: String? = null, val policyDetails: List<LifecyclePolicyPolicyDetail>? = null, val resourceSelection: LifecyclePolicyResourceSelection? = null, val resourceType: LifecyclePolicyResourceType? = null, val status: LifecyclePolicyStatus? = null, val tags: Map<String, String>? = null)
Link copied to clipboard
data class GetWorkflowResult(val arn: String? = null)
Link copied to clipboard
data class ImageEcrConfiguration(val containerTags: List<String>? = null, val repositoryName: String? = null)

Settings for Image Builder to configure the ECR repository and output container images that are scanned.

Link copied to clipboard
data class ImagePipelineEcrConfiguration(val containerTags: List<String>? = null, val repositoryName: String? = null)

Settings for Image Builder to configure the ECR repository and output container images that are scanned.

Link copied to clipboard
data class ImagePipelineImageScanningConfiguration(val ecrConfiguration: ImagePipelineEcrConfiguration? = null, val imageScanningEnabled: Boolean? = null)

Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.

Link copied to clipboard
data class ImagePipelineImageTestsConfiguration(val imageTestsEnabled: Boolean? = null, val timeoutMinutes: Int? = null)

Image tests configuration.

Link copied to clipboard
data class ImagePipelineSchedule(val pipelineExecutionStartCondition: ImagePipelineSchedulePipelineExecutionStartCondition? = null, val scheduleExpression: String? = null)

The schedule of the image pipeline.

Link copied to clipboard
data class ImagePipelineWorkflowConfiguration(val onFailure: ImagePipelineWorkflowConfigurationOnFailure? = null, val parallelGroup: String? = null, val parameters: List<ImagePipelineWorkflowParameter>? = null, val workflowArn: String? = null)

The workflow configuration of the image

Link copied to clipboard
data class ImagePipelineWorkflowParameter(val name: String? = null, val value: List<String>? = null)

A parameter associated with the workflow

data class ImageRecipeAdditionalInstanceConfiguration(val systemsManagerAgent: ImageRecipeSystemsManagerAgent? = null, val userDataOverride: String? = null)

Specify additional settings and launch scripts for your build instances.

Link copied to clipboard
data class ImageRecipeComponentConfiguration(val componentArn: String? = null, val parameters: List<ImageRecipeComponentParameter>? = null)

Configuration details of the component.

Link copied to clipboard
data class ImageRecipeComponentParameter(val name: String, val value: List<String>)

Contains a key/value pair that sets the named component parameter.

data class ImageRecipeEbsInstanceBlockDeviceSpecification(val deleteOnTermination: Boolean? = null, val encrypted: Boolean? = null, val iops: Int? = null, val kmsKeyId: String? = null, val snapshotId: String? = null, val throughput: Int? = null, val volumeSize: Int? = null, val volumeType: ImageRecipeEbsInstanceBlockDeviceSpecificationVolumeType? = null)

Amazon EBS-specific block device mapping specifications.

Link copied to clipboard
data class ImageRecipeInstanceBlockDeviceMapping(val deviceName: String? = null, val ebs: ImageRecipeEbsInstanceBlockDeviceSpecification? = null, val noDevice: String? = null, val virtualName: String? = null)

Defines block device mappings for the instance used to configure your image.

Link copied to clipboard
data class ImageRecipeSystemsManagerAgent(val uninstallAfterBuild: Boolean? = null)

Contains settings for the SSM agent on your build instance.

Link copied to clipboard
data class ImageScanningConfiguration(val ecrConfiguration: ImageEcrConfiguration? = null, val imageScanningEnabled: Boolean? = null)

Contains settings for Image Builder image resource and container image scans.

Link copied to clipboard
data class ImageTestsConfiguration(val imageTestsEnabled: Boolean? = null, val timeoutMinutes: Int? = null)

The image tests configuration used when creating this image.

Link copied to clipboard
data class ImageWorkflowConfiguration(val onFailure: ImageWorkflowConfigurationOnFailure? = null, val parallelGroup: String? = null, val parameters: List<ImageWorkflowParameter>? = null, val workflowArn: String? = null)

The workflow configuration of the image

Link copied to clipboard
data class ImageWorkflowParameter(val name: String? = null, val value: List<String>? = null)

A parameter associated with the workflow

data class InfrastructureConfigurationInstanceMetadataOptions(val httpPutResponseHopLimit: Int? = null, val httpTokens: InfrastructureConfigurationInstanceMetadataOptionsHttpTokens? = null)

The instance metadata option settings for the infrastructure configuration.

Link copied to clipboard

The logging configuration of the infrastructure configuration.

Link copied to clipboard
data class InfrastructureConfigurationPlacement(val availabilityZone: String? = null, val hostId: String? = null, val hostResourceGroupArn: String? = null, val tenancy: InfrastructureConfigurationPlacementTenancy? = null)

The placement options

Link copied to clipboard
data class InfrastructureConfigurationS3Logs(val s3BucketName: String? = null, val s3KeyPrefix: String? = null)

The S3 path in which to store the logs.

Link copied to clipboard
data class LifecyclePolicyAction(val includeResources: LifecyclePolicyIncludeResources? = null, val type: LifecyclePolicyActionType)

The action of the policy detail.

Link copied to clipboard
data class LifecyclePolicyAmiExclusionRules(val isPublic: Boolean? = null, val lastLaunched: LifecyclePolicyLastLaunched? = null, val regions: List<String>? = null, val sharedAccounts: List<String>? = null, val tagMap: Map<String, String>? = null)

The AMI exclusion rules for the policy detail.

Link copied to clipboard
data class LifecyclePolicyExclusionRules(val amis: LifecyclePolicyAmiExclusionRules? = null, val tagMap: Map<String, String>? = null)

The exclusion rules to apply of the policy detail.

Link copied to clipboard
data class LifecyclePolicyFilter(val retainAtLeast: Int? = null, val type: LifecyclePolicyFilterType, val unit: LifecyclePolicyTimeUnit? = null, val value: Int)

The filters to apply of the policy detail.

Link copied to clipboard
data class LifecyclePolicyIncludeResources(val amis: Boolean? = null, val containers: Boolean? = null, val snapshots: Boolean? = null)

The included resources of the policy detail.

Link copied to clipboard
data class LifecyclePolicyLastLaunched(val unit: LifecyclePolicyTimeUnit, val value: Int)

The last launched time of a resource.

Link copied to clipboard
data class LifecyclePolicyPolicyDetail(val action: LifecyclePolicyAction, val exclusionRules: LifecyclePolicyExclusionRules? = null, val filter: LifecyclePolicyFilter)

The policy detail of the lifecycle policy.

Link copied to clipboard
data class LifecyclePolicyRecipeSelection(val name: String, val semanticVersion: String)

The recipe to apply the lifecycle policy for.

Link copied to clipboard
data class LifecyclePolicyResourceSelection(val recipes: List<LifecyclePolicyRecipeSelection>? = null, val tagMap: Map<String, String>? = null)

The resource selection for the lifecycle policy.