| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.ImageBuilder.Types
Contents
- Service Configuration
- Errors
- BuildType
- ComponentFormat
- ComponentStatus
- ComponentType
- ContainerRepositoryService
- ContainerType
- DiskImageFormat
- EbsVolumeType
- ImageStatus
- ImageType
- Ownership
- PipelineExecutionStartCondition
- PipelineStatus
- Platform
- AdditionalInstanceConfiguration
- Ami
- AmiDistributionConfiguration
- Component
- ComponentConfiguration
- ComponentParameter
- ComponentParameterDetail
- ComponentState
- ComponentSummary
- ComponentVersion
- Container
- ContainerDistributionConfiguration
- ContainerRecipe
- ContainerRecipeSummary
- Distribution
- DistributionConfiguration
- DistributionConfigurationSummary
- EbsInstanceBlockDeviceSpecification
- FastLaunchConfiguration
- FastLaunchLaunchTemplateSpecification
- FastLaunchSnapshotConfiguration
- Filter
- Image
- ImagePackage
- ImagePipeline
- ImageRecipe
- ImageRecipeSummary
- ImageState
- ImageSummary
- ImageTestsConfiguration
- ImageVersion
- InfrastructureConfiguration
- InfrastructureConfigurationSummary
- InstanceBlockDeviceMapping
- InstanceConfiguration
- InstanceMetadataOptions
- LaunchPermissionConfiguration
- LaunchTemplateConfiguration
- Logging
- OutputResources
- S3ExportConfiguration
- S3Logs
- Schedule
- SystemsManagerAgent
- TargetContainerRepository
Description
Synopsis
- defaultService :: Service
- _CallRateLimitExceededException :: AsError a => Fold a ServiceError
- _ClientException :: AsError a => Fold a ServiceError
- _ForbiddenException :: AsError a => Fold a ServiceError
- _IdempotentParameterMismatchException :: AsError a => Fold a ServiceError
- _InvalidPaginationTokenException :: AsError a => Fold a ServiceError
- _InvalidParameterCombinationException :: AsError a => Fold a ServiceError
- _InvalidParameterException :: AsError a => Fold a ServiceError
- _InvalidParameterValueException :: AsError a => Fold a ServiceError
- _InvalidRequestException :: AsError a => Fold a ServiceError
- _InvalidVersionNumberException :: AsError a => Fold a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Fold a ServiceError
- _ResourceDependencyException :: AsError a => Fold a ServiceError
- _ResourceInUseException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ServiceUnavailableException :: AsError a => Fold a ServiceError
- newtype BuildType where
- BuildType' { }
- pattern BuildType_IMPORT :: BuildType
- pattern BuildType_SCHEDULED :: BuildType
- pattern BuildType_USER_INITIATED :: BuildType
- newtype ComponentFormat where
- ComponentFormat' { }
- pattern ComponentFormat_SHELL :: ComponentFormat
- newtype ComponentStatus where
- ComponentStatus' { }
- pattern ComponentStatus_DEPRECATED :: ComponentStatus
- newtype ComponentType where
- ComponentType' { }
- pattern ComponentType_BUILD :: ComponentType
- pattern ComponentType_TEST :: ComponentType
- newtype ContainerRepositoryService where
- newtype ContainerType where
- ContainerType' { }
- pattern ContainerType_DOCKER :: ContainerType
- newtype DiskImageFormat where
- DiskImageFormat' { }
- pattern DiskImageFormat_RAW :: DiskImageFormat
- pattern DiskImageFormat_VHD :: DiskImageFormat
- pattern DiskImageFormat_VMDK :: DiskImageFormat
- newtype EbsVolumeType where
- EbsVolumeType' { }
- pattern EbsVolumeType_Gp2 :: EbsVolumeType
- pattern EbsVolumeType_Gp3 :: EbsVolumeType
- pattern EbsVolumeType_Io1 :: EbsVolumeType
- pattern EbsVolumeType_Io2 :: EbsVolumeType
- pattern EbsVolumeType_Sc1 :: EbsVolumeType
- pattern EbsVolumeType_St1 :: EbsVolumeType
- pattern EbsVolumeType_Standard :: EbsVolumeType
- newtype ImageStatus where
- ImageStatus' { }
- pattern ImageStatus_AVAILABLE :: ImageStatus
- pattern ImageStatus_BUILDING :: ImageStatus
- pattern ImageStatus_CANCELLED :: ImageStatus
- pattern ImageStatus_CREATING :: ImageStatus
- pattern ImageStatus_DELETED :: ImageStatus
- pattern ImageStatus_DEPRECATED :: ImageStatus
- pattern ImageStatus_DISTRIBUTING :: ImageStatus
- pattern ImageStatus_FAILED :: ImageStatus
- pattern ImageStatus_INTEGRATING :: ImageStatus
- pattern ImageStatus_PENDING :: ImageStatus
- pattern ImageStatus_TESTING :: ImageStatus
- newtype ImageType where
- ImageType' { }
- pattern ImageType_AMI :: ImageType
- pattern ImageType_DOCKER :: ImageType
- newtype Ownership where
- Ownership' { }
- pattern Ownership_Amazon :: Ownership
- pattern Ownership_Self :: Ownership
- pattern Ownership_Shared :: Ownership
- newtype PipelineExecutionStartCondition where
- newtype PipelineStatus where
- PipelineStatus' { }
- pattern PipelineStatus_DISABLED :: PipelineStatus
- pattern PipelineStatus_ENABLED :: PipelineStatus
- newtype Platform where
- Platform' {
- fromPlatform :: Text
- pattern Platform_Linux :: Platform
- pattern Platform_Windows :: Platform
- Platform' {
- data AdditionalInstanceConfiguration = AdditionalInstanceConfiguration' {}
- newAdditionalInstanceConfiguration :: AdditionalInstanceConfiguration
- additionalInstanceConfiguration_systemsManagerAgent :: Lens' AdditionalInstanceConfiguration (Maybe SystemsManagerAgent)
- additionalInstanceConfiguration_userDataOverride :: Lens' AdditionalInstanceConfiguration (Maybe Text)
- data Ami = Ami' {}
- newAmi :: Ami
- ami_accountId :: Lens' Ami (Maybe Text)
- ami_description :: Lens' Ami (Maybe Text)
- ami_image :: Lens' Ami (Maybe Text)
- ami_name :: Lens' Ami (Maybe Text)
- ami_region :: Lens' Ami (Maybe Text)
- ami_state :: Lens' Ami (Maybe ImageState)
- data AmiDistributionConfiguration = AmiDistributionConfiguration' {}
- newAmiDistributionConfiguration :: AmiDistributionConfiguration
- amiDistributionConfiguration_amiTags :: Lens' AmiDistributionConfiguration (Maybe (HashMap Text Text))
- amiDistributionConfiguration_description :: Lens' AmiDistributionConfiguration (Maybe Text)
- amiDistributionConfiguration_kmsKeyId :: Lens' AmiDistributionConfiguration (Maybe Text)
- amiDistributionConfiguration_launchPermission :: Lens' AmiDistributionConfiguration (Maybe LaunchPermissionConfiguration)
- amiDistributionConfiguration_name :: Lens' AmiDistributionConfiguration (Maybe Text)
- amiDistributionConfiguration_targetAccountIds :: Lens' AmiDistributionConfiguration (Maybe (NonEmpty Text))
- data Component = Component' {
- arn :: Maybe Text
- changeDescription :: Maybe Text
- data' :: Maybe Text
- dateCreated :: Maybe Text
- description :: Maybe Text
- encrypted :: Maybe Bool
- kmsKeyId :: Maybe Text
- name :: Maybe Text
- owner :: Maybe Text
- parameters :: Maybe [ComponentParameterDetail]
- platform :: Maybe Platform
- state :: Maybe ComponentState
- supportedOsVersions :: Maybe (NonEmpty Text)
- tags :: Maybe (HashMap Text Text)
- type' :: Maybe ComponentType
- version :: Maybe Text
- newComponent :: Component
- component_arn :: Lens' Component (Maybe Text)
- component_changeDescription :: Lens' Component (Maybe Text)
- component_data :: Lens' Component (Maybe Text)
- component_dateCreated :: Lens' Component (Maybe Text)
- component_description :: Lens' Component (Maybe Text)
- component_encrypted :: Lens' Component (Maybe Bool)
- component_kmsKeyId :: Lens' Component (Maybe Text)
- component_name :: Lens' Component (Maybe Text)
- component_owner :: Lens' Component (Maybe Text)
- component_parameters :: Lens' Component (Maybe [ComponentParameterDetail])
- component_platform :: Lens' Component (Maybe Platform)
- component_state :: Lens' Component (Maybe ComponentState)
- component_supportedOsVersions :: Lens' Component (Maybe (NonEmpty Text))
- component_tags :: Lens' Component (Maybe (HashMap Text Text))
- component_type :: Lens' Component (Maybe ComponentType)
- component_version :: Lens' Component (Maybe Text)
- data ComponentConfiguration = ComponentConfiguration' {}
- newComponentConfiguration :: Text -> ComponentConfiguration
- componentConfiguration_parameters :: Lens' ComponentConfiguration (Maybe (NonEmpty ComponentParameter))
- componentConfiguration_componentArn :: Lens' ComponentConfiguration Text
- data ComponentParameter = ComponentParameter' {}
- newComponentParameter :: Text -> ComponentParameter
- componentParameter_name :: Lens' ComponentParameter Text
- componentParameter_value :: Lens' ComponentParameter [Text]
- data ComponentParameterDetail = ComponentParameterDetail' {
- defaultValue :: Maybe [Text]
- description :: Maybe Text
- name :: Text
- type' :: Text
- newComponentParameterDetail :: Text -> Text -> ComponentParameterDetail
- componentParameterDetail_defaultValue :: Lens' ComponentParameterDetail (Maybe [Text])
- componentParameterDetail_description :: Lens' ComponentParameterDetail (Maybe Text)
- componentParameterDetail_name :: Lens' ComponentParameterDetail Text
- componentParameterDetail_type :: Lens' ComponentParameterDetail Text
- data ComponentState = ComponentState' {}
- newComponentState :: ComponentState
- componentState_reason :: Lens' ComponentState (Maybe Text)
- componentState_status :: Lens' ComponentState (Maybe ComponentStatus)
- data ComponentSummary = ComponentSummary' {
- arn :: Maybe Text
- changeDescription :: Maybe Text
- dateCreated :: Maybe Text
- description :: Maybe Text
- name :: Maybe Text
- owner :: Maybe Text
- platform :: Maybe Platform
- state :: Maybe ComponentState
- supportedOsVersions :: Maybe (NonEmpty Text)
- tags :: Maybe (HashMap Text Text)
- type' :: Maybe ComponentType
- version :: Maybe Text
- newComponentSummary :: ComponentSummary
- componentSummary_arn :: Lens' ComponentSummary (Maybe Text)
- componentSummary_changeDescription :: Lens' ComponentSummary (Maybe Text)
- componentSummary_dateCreated :: Lens' ComponentSummary (Maybe Text)
- componentSummary_description :: Lens' ComponentSummary (Maybe Text)
- componentSummary_name :: Lens' ComponentSummary (Maybe Text)
- componentSummary_owner :: Lens' ComponentSummary (Maybe Text)
- componentSummary_platform :: Lens' ComponentSummary (Maybe Platform)
- componentSummary_state :: Lens' ComponentSummary (Maybe ComponentState)
- componentSummary_supportedOsVersions :: Lens' ComponentSummary (Maybe (NonEmpty Text))
- componentSummary_tags :: Lens' ComponentSummary (Maybe (HashMap Text Text))
- componentSummary_type :: Lens' ComponentSummary (Maybe ComponentType)
- componentSummary_version :: Lens' ComponentSummary (Maybe Text)
- data ComponentVersion = ComponentVersion' {}
- newComponentVersion :: ComponentVersion
- componentVersion_arn :: Lens' ComponentVersion (Maybe Text)
- componentVersion_dateCreated :: Lens' ComponentVersion (Maybe Text)
- componentVersion_description :: Lens' ComponentVersion (Maybe Text)
- componentVersion_name :: Lens' ComponentVersion (Maybe Text)
- componentVersion_owner :: Lens' ComponentVersion (Maybe Text)
- componentVersion_platform :: Lens' ComponentVersion (Maybe Platform)
- componentVersion_supportedOsVersions :: Lens' ComponentVersion (Maybe (NonEmpty Text))
- componentVersion_type :: Lens' ComponentVersion (Maybe ComponentType)
- componentVersion_version :: Lens' ComponentVersion (Maybe Text)
- data Container = Container' {}
- newContainer :: Container
- container_imageUris :: Lens' Container (Maybe [Text])
- container_region :: Lens' Container (Maybe Text)
- data ContainerDistributionConfiguration = ContainerDistributionConfiguration' {}
- newContainerDistributionConfiguration :: TargetContainerRepository -> ContainerDistributionConfiguration
- containerDistributionConfiguration_containerTags :: Lens' ContainerDistributionConfiguration (Maybe [Text])
- containerDistributionConfiguration_description :: Lens' ContainerDistributionConfiguration (Maybe Text)
- containerDistributionConfiguration_targetRepository :: Lens' ContainerDistributionConfiguration TargetContainerRepository
- data ContainerRecipe = ContainerRecipe' {
- arn :: Maybe Text
- components :: Maybe (NonEmpty ComponentConfiguration)
- containerType :: Maybe ContainerType
- dateCreated :: Maybe Text
- description :: Maybe Text
- dockerfileTemplateData :: Maybe Text
- encrypted :: Maybe Bool
- instanceConfiguration :: Maybe InstanceConfiguration
- kmsKeyId :: Maybe Text
- name :: Maybe Text
- owner :: Maybe Text
- parentImage :: Maybe Text
- platform :: Maybe Platform
- tags :: Maybe (HashMap Text Text)
- targetRepository :: Maybe TargetContainerRepository
- version :: Maybe Text
- workingDirectory :: Maybe Text
- newContainerRecipe :: ContainerRecipe
- containerRecipe_arn :: Lens' ContainerRecipe (Maybe Text)
- containerRecipe_components :: Lens' ContainerRecipe (Maybe (NonEmpty ComponentConfiguration))
- containerRecipe_containerType :: Lens' ContainerRecipe (Maybe ContainerType)
- containerRecipe_dateCreated :: Lens' ContainerRecipe (Maybe Text)
- containerRecipe_description :: Lens' ContainerRecipe (Maybe Text)
- containerRecipe_dockerfileTemplateData :: Lens' ContainerRecipe (Maybe Text)
- containerRecipe_encrypted :: Lens' ContainerRecipe (Maybe Bool)
- containerRecipe_instanceConfiguration :: Lens' ContainerRecipe (Maybe InstanceConfiguration)
- containerRecipe_kmsKeyId :: Lens' ContainerRecipe (Maybe Text)
- containerRecipe_name :: Lens' ContainerRecipe (Maybe Text)
- containerRecipe_owner :: Lens' ContainerRecipe (Maybe Text)
- containerRecipe_parentImage :: Lens' ContainerRecipe (Maybe Text)
- containerRecipe_platform :: Lens' ContainerRecipe (Maybe Platform)
- containerRecipe_tags :: Lens' ContainerRecipe (Maybe (HashMap Text Text))
- containerRecipe_targetRepository :: Lens' ContainerRecipe (Maybe TargetContainerRepository)
- containerRecipe_version :: Lens' ContainerRecipe (Maybe Text)
- containerRecipe_workingDirectory :: Lens' ContainerRecipe (Maybe Text)
- data ContainerRecipeSummary = ContainerRecipeSummary' {}
- newContainerRecipeSummary :: ContainerRecipeSummary
- containerRecipeSummary_arn :: Lens' ContainerRecipeSummary (Maybe Text)
- containerRecipeSummary_containerType :: Lens' ContainerRecipeSummary (Maybe ContainerType)
- containerRecipeSummary_dateCreated :: Lens' ContainerRecipeSummary (Maybe Text)
- containerRecipeSummary_name :: Lens' ContainerRecipeSummary (Maybe Text)
- containerRecipeSummary_owner :: Lens' ContainerRecipeSummary (Maybe Text)
- containerRecipeSummary_parentImage :: Lens' ContainerRecipeSummary (Maybe Text)
- containerRecipeSummary_platform :: Lens' ContainerRecipeSummary (Maybe Platform)
- containerRecipeSummary_tags :: Lens' ContainerRecipeSummary (Maybe (HashMap Text Text))
- data Distribution = Distribution' {
- amiDistributionConfiguration :: Maybe AmiDistributionConfiguration
- containerDistributionConfiguration :: Maybe ContainerDistributionConfiguration
- fastLaunchConfigurations :: Maybe (NonEmpty FastLaunchConfiguration)
- launchTemplateConfigurations :: Maybe (NonEmpty LaunchTemplateConfiguration)
- licenseConfigurationArns :: Maybe (NonEmpty Text)
- s3ExportConfiguration :: Maybe S3ExportConfiguration
- region :: Text
- newDistribution :: Text -> Distribution
- distribution_amiDistributionConfiguration :: Lens' Distribution (Maybe AmiDistributionConfiguration)
- distribution_containerDistributionConfiguration :: Lens' Distribution (Maybe ContainerDistributionConfiguration)
- distribution_fastLaunchConfigurations :: Lens' Distribution (Maybe (NonEmpty FastLaunchConfiguration))
- distribution_launchTemplateConfigurations :: Lens' Distribution (Maybe (NonEmpty LaunchTemplateConfiguration))
- distribution_licenseConfigurationArns :: Lens' Distribution (Maybe (NonEmpty Text))
- distribution_s3ExportConfiguration :: Lens' Distribution (Maybe S3ExportConfiguration)
- distribution_region :: Lens' Distribution Text
- data DistributionConfiguration = DistributionConfiguration' {
- arn :: Maybe Text
- dateCreated :: Maybe Text
- dateUpdated :: Maybe Text
- description :: Maybe Text
- distributions :: Maybe [Distribution]
- name :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- timeoutMinutes :: Natural
- newDistributionConfiguration :: Natural -> DistributionConfiguration
- distributionConfiguration_arn :: Lens' DistributionConfiguration (Maybe Text)
- distributionConfiguration_dateCreated :: Lens' DistributionConfiguration (Maybe Text)
- distributionConfiguration_dateUpdated :: Lens' DistributionConfiguration (Maybe Text)
- distributionConfiguration_description :: Lens' DistributionConfiguration (Maybe Text)
- distributionConfiguration_distributions :: Lens' DistributionConfiguration (Maybe [Distribution])
- distributionConfiguration_name :: Lens' DistributionConfiguration (Maybe Text)
- distributionConfiguration_tags :: Lens' DistributionConfiguration (Maybe (HashMap Text Text))
- distributionConfiguration_timeoutMinutes :: Lens' DistributionConfiguration Natural
- data DistributionConfigurationSummary = DistributionConfigurationSummary' {}
- newDistributionConfigurationSummary :: DistributionConfigurationSummary
- distributionConfigurationSummary_arn :: Lens' DistributionConfigurationSummary (Maybe Text)
- distributionConfigurationSummary_dateCreated :: Lens' DistributionConfigurationSummary (Maybe Text)
- distributionConfigurationSummary_dateUpdated :: Lens' DistributionConfigurationSummary (Maybe Text)
- distributionConfigurationSummary_description :: Lens' DistributionConfigurationSummary (Maybe Text)
- distributionConfigurationSummary_name :: Lens' DistributionConfigurationSummary (Maybe Text)
- distributionConfigurationSummary_regions :: Lens' DistributionConfigurationSummary (Maybe [Text])
- distributionConfigurationSummary_tags :: Lens' DistributionConfigurationSummary (Maybe (HashMap Text Text))
- data EbsInstanceBlockDeviceSpecification = EbsInstanceBlockDeviceSpecification' {}
- newEbsInstanceBlockDeviceSpecification :: EbsInstanceBlockDeviceSpecification
- ebsInstanceBlockDeviceSpecification_deleteOnTermination :: Lens' EbsInstanceBlockDeviceSpecification (Maybe Bool)
- ebsInstanceBlockDeviceSpecification_encrypted :: Lens' EbsInstanceBlockDeviceSpecification (Maybe Bool)
- ebsInstanceBlockDeviceSpecification_iops :: Lens' EbsInstanceBlockDeviceSpecification (Maybe Natural)
- ebsInstanceBlockDeviceSpecification_kmsKeyId :: Lens' EbsInstanceBlockDeviceSpecification (Maybe Text)
- ebsInstanceBlockDeviceSpecification_snapshotId :: Lens' EbsInstanceBlockDeviceSpecification (Maybe Text)
- ebsInstanceBlockDeviceSpecification_throughput :: Lens' EbsInstanceBlockDeviceSpecification (Maybe Natural)
- ebsInstanceBlockDeviceSpecification_volumeSize :: Lens' EbsInstanceBlockDeviceSpecification (Maybe Natural)
- ebsInstanceBlockDeviceSpecification_volumeType :: Lens' EbsInstanceBlockDeviceSpecification (Maybe EbsVolumeType)
- data FastLaunchConfiguration = FastLaunchConfiguration' {}
- newFastLaunchConfiguration :: Bool -> FastLaunchConfiguration
- fastLaunchConfiguration_accountId :: Lens' FastLaunchConfiguration (Maybe Text)
- fastLaunchConfiguration_launchTemplate :: Lens' FastLaunchConfiguration (Maybe FastLaunchLaunchTemplateSpecification)
- fastLaunchConfiguration_maxParallelLaunches :: Lens' FastLaunchConfiguration (Maybe Natural)
- fastLaunchConfiguration_snapshotConfiguration :: Lens' FastLaunchConfiguration (Maybe FastLaunchSnapshotConfiguration)
- fastLaunchConfiguration_enabled :: Lens' FastLaunchConfiguration Bool
- data FastLaunchLaunchTemplateSpecification = FastLaunchLaunchTemplateSpecification' {}
- newFastLaunchLaunchTemplateSpecification :: FastLaunchLaunchTemplateSpecification
- fastLaunchLaunchTemplateSpecification_launchTemplateId :: Lens' FastLaunchLaunchTemplateSpecification (Maybe Text)
- fastLaunchLaunchTemplateSpecification_launchTemplateName :: Lens' FastLaunchLaunchTemplateSpecification (Maybe Text)
- fastLaunchLaunchTemplateSpecification_launchTemplateVersion :: Lens' FastLaunchLaunchTemplateSpecification (Maybe Text)
- data FastLaunchSnapshotConfiguration = FastLaunchSnapshotConfiguration' {}
- newFastLaunchSnapshotConfiguration :: FastLaunchSnapshotConfiguration
- fastLaunchSnapshotConfiguration_targetResourceCount :: Lens' FastLaunchSnapshotConfiguration (Maybe Natural)
- data Filter = Filter' {}
- newFilter :: Filter
- filter_name :: Lens' Filter (Maybe Text)
- filter_values :: Lens' Filter (Maybe (NonEmpty Text))
- data Image = Image' {
- arn :: Maybe Text
- buildType :: Maybe BuildType
- containerRecipe :: Maybe ContainerRecipe
- dateCreated :: Maybe Text
- distributionConfiguration :: Maybe DistributionConfiguration
- enhancedImageMetadataEnabled :: Maybe Bool
- imageRecipe :: Maybe ImageRecipe
- imageTestsConfiguration :: Maybe ImageTestsConfiguration
- infrastructureConfiguration :: Maybe InfrastructureConfiguration
- name :: Maybe Text
- osVersion :: Maybe Text
- outputResources :: Maybe OutputResources
- platform :: Maybe Platform
- sourcePipelineArn :: Maybe Text
- sourcePipelineName :: Maybe Text
- state :: Maybe ImageState
- tags :: Maybe (HashMap Text Text)
- type' :: Maybe ImageType
- version :: Maybe Text
- newImage :: Image
- image_arn :: Lens' Image (Maybe Text)
- image_buildType :: Lens' Image (Maybe BuildType)
- image_containerRecipe :: Lens' Image (Maybe ContainerRecipe)
- image_dateCreated :: Lens' Image (Maybe Text)
- image_distributionConfiguration :: Lens' Image (Maybe DistributionConfiguration)
- image_enhancedImageMetadataEnabled :: Lens' Image (Maybe Bool)
- image_imageRecipe :: Lens' Image (Maybe ImageRecipe)
- image_imageTestsConfiguration :: Lens' Image (Maybe ImageTestsConfiguration)
- image_infrastructureConfiguration :: Lens' Image (Maybe InfrastructureConfiguration)
- image_name :: Lens' Image (Maybe Text)
- image_osVersion :: Lens' Image (Maybe Text)
- image_outputResources :: Lens' Image (Maybe OutputResources)
- image_platform :: Lens' Image (Maybe Platform)
- image_sourcePipelineArn :: Lens' Image (Maybe Text)
- image_sourcePipelineName :: Lens' Image (Maybe Text)
- image_state :: Lens' Image (Maybe ImageState)
- image_tags :: Lens' Image (Maybe (HashMap Text Text))
- image_type :: Lens' Image (Maybe ImageType)
- image_version :: Lens' Image (Maybe Text)
- data ImagePackage = ImagePackage' {}
- newImagePackage :: ImagePackage
- imagePackage_packageName :: Lens' ImagePackage (Maybe Text)
- imagePackage_packageVersion :: Lens' ImagePackage (Maybe Text)
- data ImagePipeline = ImagePipeline' {
- arn :: Maybe Text
- containerRecipeArn :: Maybe Text
- dateCreated :: Maybe Text
- dateLastRun :: Maybe Text
- dateNextRun :: Maybe Text
- dateUpdated :: Maybe Text
- description :: Maybe Text
- distributionConfigurationArn :: Maybe Text
- enhancedImageMetadataEnabled :: Maybe Bool
- imageRecipeArn :: Maybe Text
- imageTestsConfiguration :: Maybe ImageTestsConfiguration
- infrastructureConfigurationArn :: Maybe Text
- name :: Maybe Text
- platform :: Maybe Platform
- schedule :: Maybe Schedule
- status :: Maybe PipelineStatus
- tags :: Maybe (HashMap Text Text)
- newImagePipeline :: ImagePipeline
- imagePipeline_arn :: Lens' ImagePipeline (Maybe Text)
- imagePipeline_containerRecipeArn :: Lens' ImagePipeline (Maybe Text)
- imagePipeline_dateCreated :: Lens' ImagePipeline (Maybe Text)
- imagePipeline_dateLastRun :: Lens' ImagePipeline (Maybe Text)
- imagePipeline_dateNextRun :: Lens' ImagePipeline (Maybe Text)
- imagePipeline_dateUpdated :: Lens' ImagePipeline (Maybe Text)
- imagePipeline_description :: Lens' ImagePipeline (Maybe Text)
- imagePipeline_distributionConfigurationArn :: Lens' ImagePipeline (Maybe Text)
- imagePipeline_enhancedImageMetadataEnabled :: Lens' ImagePipeline (Maybe Bool)
- imagePipeline_imageRecipeArn :: Lens' ImagePipeline (Maybe Text)
- imagePipeline_imageTestsConfiguration :: Lens' ImagePipeline (Maybe ImageTestsConfiguration)
- imagePipeline_infrastructureConfigurationArn :: Lens' ImagePipeline (Maybe Text)
- imagePipeline_name :: Lens' ImagePipeline (Maybe Text)
- imagePipeline_platform :: Lens' ImagePipeline (Maybe Platform)
- imagePipeline_schedule :: Lens' ImagePipeline (Maybe Schedule)
- imagePipeline_status :: Lens' ImagePipeline (Maybe PipelineStatus)
- imagePipeline_tags :: Lens' ImagePipeline (Maybe (HashMap Text Text))
- data ImageRecipe = ImageRecipe' {
- additionalInstanceConfiguration :: Maybe AdditionalInstanceConfiguration
- arn :: Maybe Text
- blockDeviceMappings :: Maybe [InstanceBlockDeviceMapping]
- components :: Maybe (NonEmpty ComponentConfiguration)
- dateCreated :: Maybe Text
- description :: Maybe Text
- name :: Maybe Text
- owner :: Maybe Text
- parentImage :: Maybe Text
- platform :: Maybe Platform
- tags :: Maybe (HashMap Text Text)
- type' :: Maybe ImageType
- version :: Maybe Text
- workingDirectory :: Maybe Text
- newImageRecipe :: ImageRecipe
- imageRecipe_additionalInstanceConfiguration :: Lens' ImageRecipe (Maybe AdditionalInstanceConfiguration)
- imageRecipe_arn :: Lens' ImageRecipe (Maybe Text)
- imageRecipe_blockDeviceMappings :: Lens' ImageRecipe (Maybe [InstanceBlockDeviceMapping])
- imageRecipe_components :: Lens' ImageRecipe (Maybe (NonEmpty ComponentConfiguration))
- imageRecipe_dateCreated :: Lens' ImageRecipe (Maybe Text)
- imageRecipe_description :: Lens' ImageRecipe (Maybe Text)
- imageRecipe_name :: Lens' ImageRecipe (Maybe Text)
- imageRecipe_owner :: Lens' ImageRecipe (Maybe Text)
- imageRecipe_parentImage :: Lens' ImageRecipe (Maybe Text)
- imageRecipe_platform :: Lens' ImageRecipe (Maybe Platform)
- imageRecipe_tags :: Lens' ImageRecipe (Maybe (HashMap Text Text))
- imageRecipe_type :: Lens' ImageRecipe (Maybe ImageType)
- imageRecipe_version :: Lens' ImageRecipe (Maybe Text)
- imageRecipe_workingDirectory :: Lens' ImageRecipe (Maybe Text)
- data ImageRecipeSummary = ImageRecipeSummary' {}
- newImageRecipeSummary :: ImageRecipeSummary
- imageRecipeSummary_arn :: Lens' ImageRecipeSummary (Maybe Text)
- imageRecipeSummary_dateCreated :: Lens' ImageRecipeSummary (Maybe Text)
- imageRecipeSummary_name :: Lens' ImageRecipeSummary (Maybe Text)
- imageRecipeSummary_owner :: Lens' ImageRecipeSummary (Maybe Text)
- imageRecipeSummary_parentImage :: Lens' ImageRecipeSummary (Maybe Text)
- imageRecipeSummary_platform :: Lens' ImageRecipeSummary (Maybe Platform)
- imageRecipeSummary_tags :: Lens' ImageRecipeSummary (Maybe (HashMap Text Text))
- data ImageState = ImageState' {}
- newImageState :: ImageState
- imageState_reason :: Lens' ImageState (Maybe Text)
- imageState_status :: Lens' ImageState (Maybe ImageStatus)
- data ImageSummary = ImageSummary' {}
- newImageSummary :: ImageSummary
- imageSummary_arn :: Lens' ImageSummary (Maybe Text)
- imageSummary_buildType :: Lens' ImageSummary (Maybe BuildType)
- imageSummary_dateCreated :: Lens' ImageSummary (Maybe Text)
- imageSummary_name :: Lens' ImageSummary (Maybe Text)
- imageSummary_osVersion :: Lens' ImageSummary (Maybe Text)
- imageSummary_outputResources :: Lens' ImageSummary (Maybe OutputResources)
- imageSummary_owner :: Lens' ImageSummary (Maybe Text)
- imageSummary_platform :: Lens' ImageSummary (Maybe Platform)
- imageSummary_state :: Lens' ImageSummary (Maybe ImageState)
- imageSummary_tags :: Lens' ImageSummary (Maybe (HashMap Text Text))
- imageSummary_type :: Lens' ImageSummary (Maybe ImageType)
- imageSummary_version :: Lens' ImageSummary (Maybe Text)
- data ImageTestsConfiguration = ImageTestsConfiguration' {}
- newImageTestsConfiguration :: ImageTestsConfiguration
- imageTestsConfiguration_imageTestsEnabled :: Lens' ImageTestsConfiguration (Maybe Bool)
- imageTestsConfiguration_timeoutMinutes :: Lens' ImageTestsConfiguration (Maybe Natural)
- data ImageVersion = ImageVersion' {}
- newImageVersion :: ImageVersion
- imageVersion_arn :: Lens' ImageVersion (Maybe Text)
- imageVersion_buildType :: Lens' ImageVersion (Maybe BuildType)
- imageVersion_dateCreated :: Lens' ImageVersion (Maybe Text)
- imageVersion_name :: Lens' ImageVersion (Maybe Text)
- imageVersion_osVersion :: Lens' ImageVersion (Maybe Text)
- imageVersion_owner :: Lens' ImageVersion (Maybe Text)
- imageVersion_platform :: Lens' ImageVersion (Maybe Platform)
- imageVersion_type :: Lens' ImageVersion (Maybe ImageType)
- imageVersion_version :: Lens' ImageVersion (Maybe Text)
- data InfrastructureConfiguration = InfrastructureConfiguration' {
- arn :: Maybe Text
- dateCreated :: Maybe Text
- dateUpdated :: Maybe Text
- description :: Maybe Text
- instanceMetadataOptions :: Maybe InstanceMetadataOptions
- instanceProfileName :: Maybe Text
- instanceTypes :: Maybe [Text]
- keyPair :: Maybe Text
- logging :: Maybe Logging
- name :: Maybe Text
- resourceTags :: Maybe (HashMap Text Text)
- securityGroupIds :: Maybe [Text]
- snsTopicArn :: Maybe Text
- subnetId :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- terminateInstanceOnFailure :: Maybe Bool
- newInfrastructureConfiguration :: InfrastructureConfiguration
- infrastructureConfiguration_arn :: Lens' InfrastructureConfiguration (Maybe Text)
- infrastructureConfiguration_dateCreated :: Lens' InfrastructureConfiguration (Maybe Text)
- infrastructureConfiguration_dateUpdated :: Lens' InfrastructureConfiguration (Maybe Text)
- infrastructureConfiguration_description :: Lens' InfrastructureConfiguration (Maybe Text)
- infrastructureConfiguration_instanceMetadataOptions :: Lens' InfrastructureConfiguration (Maybe InstanceMetadataOptions)
- infrastructureConfiguration_instanceProfileName :: Lens' InfrastructureConfiguration (Maybe Text)
- infrastructureConfiguration_instanceTypes :: Lens' InfrastructureConfiguration (Maybe [Text])
- infrastructureConfiguration_keyPair :: Lens' InfrastructureConfiguration (Maybe Text)
- infrastructureConfiguration_logging :: Lens' InfrastructureConfiguration (Maybe Logging)
- infrastructureConfiguration_name :: Lens' InfrastructureConfiguration (Maybe Text)
- infrastructureConfiguration_resourceTags :: Lens' InfrastructureConfiguration (Maybe (HashMap Text Text))
- infrastructureConfiguration_securityGroupIds :: Lens' InfrastructureConfiguration (Maybe [Text])
- infrastructureConfiguration_snsTopicArn :: Lens' InfrastructureConfiguration (Maybe Text)
- infrastructureConfiguration_subnetId :: Lens' InfrastructureConfiguration (Maybe Text)
- infrastructureConfiguration_tags :: Lens' InfrastructureConfiguration (Maybe (HashMap Text Text))
- infrastructureConfiguration_terminateInstanceOnFailure :: Lens' InfrastructureConfiguration (Maybe Bool)
- data InfrastructureConfigurationSummary = InfrastructureConfigurationSummary' {}
- newInfrastructureConfigurationSummary :: InfrastructureConfigurationSummary
- infrastructureConfigurationSummary_arn :: Lens' InfrastructureConfigurationSummary (Maybe Text)
- infrastructureConfigurationSummary_dateCreated :: Lens' InfrastructureConfigurationSummary (Maybe Text)
- infrastructureConfigurationSummary_dateUpdated :: Lens' InfrastructureConfigurationSummary (Maybe Text)
- infrastructureConfigurationSummary_description :: Lens' InfrastructureConfigurationSummary (Maybe Text)
- infrastructureConfigurationSummary_instanceProfileName :: Lens' InfrastructureConfigurationSummary (Maybe Text)
- infrastructureConfigurationSummary_instanceTypes :: Lens' InfrastructureConfigurationSummary (Maybe [Text])
- infrastructureConfigurationSummary_name :: Lens' InfrastructureConfigurationSummary (Maybe Text)
- infrastructureConfigurationSummary_resourceTags :: Lens' InfrastructureConfigurationSummary (Maybe (HashMap Text Text))
- infrastructureConfigurationSummary_tags :: Lens' InfrastructureConfigurationSummary (Maybe (HashMap Text Text))
- data InstanceBlockDeviceMapping = InstanceBlockDeviceMapping' {}
- newInstanceBlockDeviceMapping :: InstanceBlockDeviceMapping
- instanceBlockDeviceMapping_deviceName :: Lens' InstanceBlockDeviceMapping (Maybe Text)
- instanceBlockDeviceMapping_ebs :: Lens' InstanceBlockDeviceMapping (Maybe EbsInstanceBlockDeviceSpecification)
- instanceBlockDeviceMapping_noDevice :: Lens' InstanceBlockDeviceMapping (Maybe Text)
- instanceBlockDeviceMapping_virtualName :: Lens' InstanceBlockDeviceMapping (Maybe Text)
- data InstanceConfiguration = InstanceConfiguration' {}
- newInstanceConfiguration :: InstanceConfiguration
- instanceConfiguration_blockDeviceMappings :: Lens' InstanceConfiguration (Maybe [InstanceBlockDeviceMapping])
- instanceConfiguration_image :: Lens' InstanceConfiguration (Maybe Text)
- data InstanceMetadataOptions = InstanceMetadataOptions' {}
- newInstanceMetadataOptions :: InstanceMetadataOptions
- instanceMetadataOptions_httpPutResponseHopLimit :: Lens' InstanceMetadataOptions (Maybe Natural)
- instanceMetadataOptions_httpTokens :: Lens' InstanceMetadataOptions (Maybe Text)
- data LaunchPermissionConfiguration = LaunchPermissionConfiguration' {
- organizationArns :: Maybe (NonEmpty Text)
- organizationalUnitArns :: Maybe (NonEmpty Text)
- userGroups :: Maybe [Text]
- userIds :: Maybe (NonEmpty Text)
- newLaunchPermissionConfiguration :: LaunchPermissionConfiguration
- launchPermissionConfiguration_organizationArns :: Lens' LaunchPermissionConfiguration (Maybe (NonEmpty Text))
- launchPermissionConfiguration_organizationalUnitArns :: Lens' LaunchPermissionConfiguration (Maybe (NonEmpty Text))
- launchPermissionConfiguration_userGroups :: Lens' LaunchPermissionConfiguration (Maybe [Text])
- launchPermissionConfiguration_userIds :: Lens' LaunchPermissionConfiguration (Maybe (NonEmpty Text))
- data LaunchTemplateConfiguration = LaunchTemplateConfiguration' {}
- newLaunchTemplateConfiguration :: Text -> LaunchTemplateConfiguration
- launchTemplateConfiguration_accountId :: Lens' LaunchTemplateConfiguration (Maybe Text)
- launchTemplateConfiguration_setDefaultVersion :: Lens' LaunchTemplateConfiguration (Maybe Bool)
- launchTemplateConfiguration_launchTemplateId :: Lens' LaunchTemplateConfiguration Text
- data Logging = Logging' {}
- newLogging :: Logging
- logging_s3Logs :: Lens' Logging (Maybe S3Logs)
- data OutputResources = OutputResources' {}
- newOutputResources :: OutputResources
- outputResources_amis :: Lens' OutputResources (Maybe [Ami])
- outputResources_containers :: Lens' OutputResources (Maybe [Container])
- data S3ExportConfiguration = S3ExportConfiguration' {}
- newS3ExportConfiguration :: Text -> DiskImageFormat -> Text -> S3ExportConfiguration
- s3ExportConfiguration_s3Prefix :: Lens' S3ExportConfiguration (Maybe Text)
- s3ExportConfiguration_roleName :: Lens' S3ExportConfiguration Text
- s3ExportConfiguration_diskImageFormat :: Lens' S3ExportConfiguration DiskImageFormat
- s3ExportConfiguration_s3Bucket :: Lens' S3ExportConfiguration Text
- data S3Logs = S3Logs' {}
- newS3Logs :: S3Logs
- s3Logs_s3BucketName :: Lens' S3Logs (Maybe Text)
- s3Logs_s3KeyPrefix :: Lens' S3Logs (Maybe Text)
- data Schedule = Schedule' {}
- newSchedule :: Schedule
- schedule_pipelineExecutionStartCondition :: Lens' Schedule (Maybe PipelineExecutionStartCondition)
- schedule_scheduleExpression :: Lens' Schedule (Maybe Text)
- schedule_timezone :: Lens' Schedule (Maybe Text)
- data SystemsManagerAgent = SystemsManagerAgent' {}
- newSystemsManagerAgent :: SystemsManagerAgent
- systemsManagerAgent_uninstallAfterBuild :: Lens' SystemsManagerAgent (Maybe Bool)
- data TargetContainerRepository = TargetContainerRepository' {}
- newTargetContainerRepository :: ContainerRepositoryService -> Text -> TargetContainerRepository
- targetContainerRepository_service :: Lens' TargetContainerRepository ContainerRepositoryService
- targetContainerRepository_repositoryName :: Lens' TargetContainerRepository Text
Service Configuration
defaultService :: Service Source #
API version 2019-12-02 of the Amazon EC2 Image Builder SDK configuration.
Errors
_CallRateLimitExceededException :: AsError a => Fold a ServiceError Source #
You have exceeded the permitted request rate for the specific operation.
_ClientException :: AsError a => Fold a ServiceError Source #
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
_ForbiddenException :: AsError a => Fold a ServiceError Source #
You are not authorized to perform the requested operation.
_IdempotentParameterMismatchException :: AsError a => Fold a ServiceError Source #
You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
_InvalidPaginationTokenException :: AsError a => Fold a ServiceError Source #
You have provided an invalid pagination token in your request.
_InvalidParameterCombinationException :: AsError a => Fold a ServiceError Source #
You have specified two or more mutually exclusive parameters. Review the error message for details.
_InvalidParameterException :: AsError a => Fold a ServiceError Source #
The specified parameter is invalid. Review the available parameters for the API request.
_InvalidParameterValueException :: AsError a => Fold a ServiceError Source #
The value that you provided for the specified parameter is invalid.
_InvalidRequestException :: AsError a => Fold a ServiceError Source #
You have made a request for an action that is not supported by the service.
_InvalidVersionNumberException :: AsError a => Fold a ServiceError Source #
Your version number is out of bounds or does not follow the required syntax.
_ResourceAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The resource that you are trying to create already exists.
_ResourceDependencyException :: AsError a => Fold a ServiceError Source #
You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
_ResourceInUseException :: AsError a => Fold a ServiceError Source #
The resource that you are trying to operate on is currently in use. Review the message details and retry later.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
At least one of the resources referenced by your request does not exist.
_ServiceException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the service encounters an unrecoverable exception.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #
The service is unable to process your request at this time.
BuildType
Constructors
| BuildType' | |
Fields | |
Bundled Patterns
| pattern BuildType_IMPORT :: BuildType | |
| pattern BuildType_SCHEDULED :: BuildType | |
| pattern BuildType_USER_INITIATED :: BuildType |
Instances
ComponentFormat
newtype ComponentFormat Source #
Constructors
| ComponentFormat' | |
Fields | |
Bundled Patterns
| pattern ComponentFormat_SHELL :: ComponentFormat |
Instances
ComponentStatus
newtype ComponentStatus Source #
Constructors
| ComponentStatus' | |
Fields | |
Bundled Patterns
| pattern ComponentStatus_DEPRECATED :: ComponentStatus |
Instances
ComponentType
newtype ComponentType Source #
Constructors
| ComponentType' | |
Fields | |
Bundled Patterns
| pattern ComponentType_BUILD :: ComponentType | |
| pattern ComponentType_TEST :: ComponentType |
Instances
ContainerRepositoryService
newtype ContainerRepositoryService Source #
Constructors
| ContainerRepositoryService' | |
Fields | |
Bundled Patterns
| pattern ContainerRepositoryService_ECR :: ContainerRepositoryService |
Instances
ContainerType
newtype ContainerType Source #
Constructors
| ContainerType' | |
Fields | |
Bundled Patterns
| pattern ContainerType_DOCKER :: ContainerType |
Instances
DiskImageFormat
newtype DiskImageFormat Source #
Constructors
| DiskImageFormat' | |
Fields | |
Bundled Patterns
| pattern DiskImageFormat_RAW :: DiskImageFormat | |
| pattern DiskImageFormat_VHD :: DiskImageFormat | |
| pattern DiskImageFormat_VMDK :: DiskImageFormat |
Instances
EbsVolumeType
newtype EbsVolumeType Source #
Constructors
| EbsVolumeType' | |
Fields | |
Bundled Patterns
| pattern EbsVolumeType_Gp2 :: EbsVolumeType | |
| pattern EbsVolumeType_Gp3 :: EbsVolumeType | |
| pattern EbsVolumeType_Io1 :: EbsVolumeType | |
| pattern EbsVolumeType_Io2 :: EbsVolumeType | |
| pattern EbsVolumeType_Sc1 :: EbsVolumeType | |
| pattern EbsVolumeType_St1 :: EbsVolumeType | |
| pattern EbsVolumeType_Standard :: EbsVolumeType |
Instances
ImageStatus
newtype ImageStatus Source #
Constructors
| ImageStatus' | |
Fields | |
Bundled Patterns
| pattern ImageStatus_AVAILABLE :: ImageStatus | |
| pattern ImageStatus_BUILDING :: ImageStatus | |
| pattern ImageStatus_CANCELLED :: ImageStatus | |
| pattern ImageStatus_CREATING :: ImageStatus | |
| pattern ImageStatus_DELETED :: ImageStatus | |
| pattern ImageStatus_DEPRECATED :: ImageStatus | |
| pattern ImageStatus_DISTRIBUTING :: ImageStatus | |
| pattern ImageStatus_FAILED :: ImageStatus | |
| pattern ImageStatus_INTEGRATING :: ImageStatus | |
| pattern ImageStatus_PENDING :: ImageStatus | |
| pattern ImageStatus_TESTING :: ImageStatus |
Instances
ImageType
Constructors
| ImageType' | |
Fields | |
Bundled Patterns
| pattern ImageType_AMI :: ImageType | |
| pattern ImageType_DOCKER :: ImageType |
Instances
Ownership
Constructors
| Ownership' | |
Fields | |
Bundled Patterns
| pattern Ownership_Amazon :: Ownership | |
| pattern Ownership_Self :: Ownership | |
| pattern Ownership_Shared :: Ownership |
Instances
PipelineExecutionStartCondition
newtype PipelineExecutionStartCondition Source #
Constructors
| PipelineExecutionStartCondition' | |
Fields | |
Bundled Patterns
Instances
PipelineStatus
newtype PipelineStatus Source #
Constructors
| PipelineStatus' | |
Fields | |
Bundled Patterns
| pattern PipelineStatus_DISABLED :: PipelineStatus | |
| pattern PipelineStatus_ENABLED :: PipelineStatus |
Instances
Platform
Constructors
| Platform' | |
Fields
| |
Bundled Patterns
| pattern Platform_Linux :: Platform | |
| pattern Platform_Windows :: Platform |
Instances
AdditionalInstanceConfiguration
data AdditionalInstanceConfiguration Source #
In addition to your infrastruction configuration, these settings provide an extra layer of control over your build instances. For instances where Image Builder installs the Systems Manager agent, you can choose whether to keep it for the AMI that you create. You can also specify commands to run on launch for all of your build instances.
See: newAdditionalInstanceConfiguration smart constructor.
Constructors
| AdditionalInstanceConfiguration' | |
Fields
| |
Instances
newAdditionalInstanceConfiguration :: AdditionalInstanceConfiguration Source #
Create a value of AdditionalInstanceConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:systemsManagerAgent:AdditionalInstanceConfiguration', additionalInstanceConfiguration_systemsManagerAgent - Contains settings for the Systems Manager agent on your build instance.
$sel:userDataOverride:AdditionalInstanceConfiguration', additionalInstanceConfiguration_userDataOverride - Use this property to provide commands or a command script to run when
you launch your build instance.
The userDataOverride property replaces any commands that Image Builder might have added to ensure that Systems Manager is installed on your Linux build instance. If you override the user data, make sure that you add commands to install Systems Manager, if it is not pre-installed on your base image.
The user data is always base 64 encoded. For example, the following
commands are encoded as
IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$:
#!/bin/bash
mkdir -p /var/bb/
touch /var
additionalInstanceConfiguration_systemsManagerAgent :: Lens' AdditionalInstanceConfiguration (Maybe SystemsManagerAgent) Source #
Contains settings for the Systems Manager agent on your build instance.
additionalInstanceConfiguration_userDataOverride :: Lens' AdditionalInstanceConfiguration (Maybe Text) Source #
Use this property to provide commands or a command script to run when you launch your build instance.
The userDataOverride property replaces any commands that Image Builder might have added to ensure that Systems Manager is installed on your Linux build instance. If you override the user data, make sure that you add commands to install Systems Manager, if it is not pre-installed on your base image.
The user data is always base 64 encoded. For example, the following
commands are encoded as
IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$:
#!/bin/bash
mkdir -p /var/bb/
touch /var
Ami
Details of an Amazon EC2 AMI.
See: newAmi smart constructor.
Constructors
| Ami' | |
Fields
| |
Instances
Create a value of Ami with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:Ami', ami_accountId - The account ID of the owner of the AMI.
$sel:description:Ami', ami_description - The description of the Amazon EC2 AMI. Minimum and maximum length are in
characters.
$sel:image:Ami', ami_image - The AMI ID of the Amazon EC2 AMI.
$sel:name:Ami', ami_name - The name of the Amazon EC2 AMI.
$sel:region:Ami', ami_region - The Amazon Web Services Region of the Amazon EC2 AMI.
$sel:state:Ami', ami_state - Undocumented member.
ami_description :: Lens' Ami (Maybe Text) Source #
The description of the Amazon EC2 AMI. Minimum and maximum length are in characters.
AmiDistributionConfiguration
data AmiDistributionConfiguration Source #
Define and configure the output AMIs of the pipeline.
See: newAmiDistributionConfiguration smart constructor.
Constructors
| AmiDistributionConfiguration' | |
Fields
| |
Instances
newAmiDistributionConfiguration :: AmiDistributionConfiguration Source #
Create a value of AmiDistributionConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:amiTags:AmiDistributionConfiguration', amiDistributionConfiguration_amiTags - The tags to apply to AMIs distributed to this Region.
$sel:description:AmiDistributionConfiguration', amiDistributionConfiguration_description - The description of the AMI distribution configuration. Minimum and
maximum length are in characters.
$sel:kmsKeyId:AmiDistributionConfiguration', amiDistributionConfiguration_kmsKeyId - The KMS key identifier used to encrypt the distributed image.
$sel:launchPermission:AmiDistributionConfiguration', amiDistributionConfiguration_launchPermission - Launch permissions can be used to configure which Amazon Web Services
accounts can use the AMI to launch instances.
$sel:name:AmiDistributionConfiguration', amiDistributionConfiguration_name - The name of the output AMI.
$sel:targetAccountIds:AmiDistributionConfiguration', amiDistributionConfiguration_targetAccountIds - The ID of an account to which you want to distribute an image.
amiDistributionConfiguration_amiTags :: Lens' AmiDistributionConfiguration (Maybe (HashMap Text Text)) Source #
The tags to apply to AMIs distributed to this Region.
amiDistributionConfiguration_description :: Lens' AmiDistributionConfiguration (Maybe Text) Source #
The description of the AMI distribution configuration. Minimum and maximum length are in characters.
amiDistributionConfiguration_kmsKeyId :: Lens' AmiDistributionConfiguration (Maybe Text) Source #
The KMS key identifier used to encrypt the distributed image.
amiDistributionConfiguration_launchPermission :: Lens' AmiDistributionConfiguration (Maybe LaunchPermissionConfiguration) Source #
Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.
amiDistributionConfiguration_name :: Lens' AmiDistributionConfiguration (Maybe Text) Source #
The name of the output AMI.
amiDistributionConfiguration_targetAccountIds :: Lens' AmiDistributionConfiguration (Maybe (NonEmpty Text)) Source #
The ID of an account to which you want to distribute an image.
Component
A detailed view of a component.
See: newComponent smart constructor.
Constructors
| Component' | |
Fields
| |
Instances
newComponent :: Component Source #
Create a value of Component with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:Component', component_arn - The Amazon Resource Name (ARN) of the component.
$sel:changeDescription:Component', component_changeDescription - The change description of the component.
$sel:data':Component', component_data - Component data contains the YAML document content for the component.
$sel:dateCreated:Component', component_dateCreated - The date that the component was created.
Component, component_description - The description of the component.
$sel:encrypted:Component', component_encrypted - The encryption status of the component.
$sel:kmsKeyId:Component', component_kmsKeyId - The KMS key identifier used to encrypt the component.
Component, component_name - The name of the component.
$sel:owner:Component', component_owner - The owner of the component.
$sel:parameters:Component', component_parameters - Contains parameter details for each of the parameters that are defined
for the component.
$sel:platform:Component', component_platform - The platform of the component.
$sel:state:Component', component_state - Describes the current status of the component. This is used for
components that are no longer active.
$sel:supportedOsVersions:Component', component_supportedOsVersions - The operating system (OS) version supported by the component. If the OS
information is available, a prefix match is performed against the base
image OS version during image recipe creation.
$sel:tags:Component', component_tags - The tags associated with the component.
Component, component_type - The type of the component denotes whether the component is used to build
the image or only to test it.
$sel:version:Component', component_version - The version of the component.
component_arn :: Lens' Component (Maybe Text) Source #
The Amazon Resource Name (ARN) of the component.
component_changeDescription :: Lens' Component (Maybe Text) Source #
The change description of the component.
component_data :: Lens' Component (Maybe Text) Source #
Component data contains the YAML document content for the component.
component_dateCreated :: Lens' Component (Maybe Text) Source #
The date that the component was created.
component_kmsKeyId :: Lens' Component (Maybe Text) Source #
The KMS key identifier used to encrypt the component.
component_parameters :: Lens' Component (Maybe [ComponentParameterDetail]) Source #
Contains parameter details for each of the parameters that are defined for the component.
component_state :: Lens' Component (Maybe ComponentState) Source #
Describes the current status of the component. This is used for components that are no longer active.
component_supportedOsVersions :: Lens' Component (Maybe (NonEmpty Text)) Source #
The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.
component_tags :: Lens' Component (Maybe (HashMap Text Text)) Source #
The tags associated with the component.
component_type :: Lens' Component (Maybe ComponentType) Source #
The type of the component denotes whether the component is used to build the image or only to test it.
ComponentConfiguration
data ComponentConfiguration Source #
Configuration details of the component.
See: newComponentConfiguration smart constructor.
Constructors
| ComponentConfiguration' | |
Fields
| |
Instances
newComponentConfiguration Source #
Create a value of ComponentConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:parameters:ComponentConfiguration', componentConfiguration_parameters - A group of parameter settings that are used to configure the component
for a specific recipe.
$sel:componentArn:ComponentConfiguration', componentConfiguration_componentArn - The Amazon Resource Name (ARN) of the component.
componentConfiguration_parameters :: Lens' ComponentConfiguration (Maybe (NonEmpty ComponentParameter)) Source #
A group of parameter settings that are used to configure the component for a specific recipe.
componentConfiguration_componentArn :: Lens' ComponentConfiguration Text Source #
The Amazon Resource Name (ARN) of the component.
ComponentParameter
data ComponentParameter Source #
Contains a key/value pair that sets the named component parameter.
See: newComponentParameter smart constructor.
Constructors
| ComponentParameter' | |
Instances
newComponentParameter Source #
Arguments
| :: Text | |
| -> ComponentParameter |
Create a value of ComponentParameter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:ComponentParameter', componentParameter_name - The name of the component parameter to set.
$sel:value:ComponentParameter', componentParameter_value - Sets the value for the named component parameter.
componentParameter_name :: Lens' ComponentParameter Text Source #
The name of the component parameter to set.
componentParameter_value :: Lens' ComponentParameter [Text] Source #
Sets the value for the named component parameter.
ComponentParameterDetail
data ComponentParameterDetail Source #
Defines a parameter that is used to provide configuration details for the component.
See: newComponentParameterDetail smart constructor.
Constructors
| ComponentParameterDetail' | |
Fields
| |
Instances
newComponentParameterDetail Source #
Arguments
| :: Text | |
| -> Text | |
| -> ComponentParameterDetail |
Create a value of ComponentParameterDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultValue:ComponentParameterDetail', componentParameterDetail_defaultValue - The default value of this parameter if no input is provided.
$sel:description:ComponentParameterDetail', componentParameterDetail_description - Describes this parameter.
$sel:name:ComponentParameterDetail', componentParameterDetail_name - The name of this input parameter.
$sel:type':ComponentParameterDetail', componentParameterDetail_type - The type of input this parameter provides. The currently supported value
is "string".
componentParameterDetail_defaultValue :: Lens' ComponentParameterDetail (Maybe [Text]) Source #
The default value of this parameter if no input is provided.
componentParameterDetail_description :: Lens' ComponentParameterDetail (Maybe Text) Source #
Describes this parameter.
componentParameterDetail_name :: Lens' ComponentParameterDetail Text Source #
The name of this input parameter.
componentParameterDetail_type :: Lens' ComponentParameterDetail Text Source #
The type of input this parameter provides. The currently supported value is "string".
ComponentState
data ComponentState Source #
A group of fields that describe the current status of components that are no longer active.
See: newComponentState smart constructor.
Constructors
| ComponentState' | |
Instances
newComponentState :: ComponentState Source #
Create a value of ComponentState with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:reason:ComponentState', componentState_reason - Describes how or why the component changed state.
$sel:status:ComponentState', componentState_status - The current state of the component.
componentState_reason :: Lens' ComponentState (Maybe Text) Source #
Describes how or why the component changed state.
componentState_status :: Lens' ComponentState (Maybe ComponentStatus) Source #
The current state of the component.
ComponentSummary
data ComponentSummary Source #
A high-level summary of a component.
See: newComponentSummary smart constructor.
Constructors
| ComponentSummary' | |
Fields
| |
Instances
newComponentSummary :: ComponentSummary Source #
Create a value of ComponentSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ComponentSummary', componentSummary_arn - The Amazon Resource Name (ARN) of the component.
$sel:changeDescription:ComponentSummary', componentSummary_changeDescription - The change description of the component.
$sel:dateCreated:ComponentSummary', componentSummary_dateCreated - The date that the component was created.
$sel:description:ComponentSummary', componentSummary_description - The description of the component.
$sel:name:ComponentSummary', componentSummary_name - The name of the component.
$sel:owner:ComponentSummary', componentSummary_owner - The owner of the component.
$sel:platform:ComponentSummary', componentSummary_platform - The platform of the component.
$sel:state:ComponentSummary', componentSummary_state - Describes the current status of the component.
$sel:supportedOsVersions:ComponentSummary', componentSummary_supportedOsVersions - The operating system (OS) version supported by the component. If the OS
information is available, a prefix match is performed against the base
image OS version during image recipe creation.
$sel:tags:ComponentSummary', componentSummary_tags - The tags associated with the component.
$sel:type':ComponentSummary', componentSummary_type - The type of the component denotes whether the component is used to build
the image or only to test it.
$sel:version:ComponentSummary', componentSummary_version - The version of the component.
componentSummary_arn :: Lens' ComponentSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the component.
componentSummary_changeDescription :: Lens' ComponentSummary (Maybe Text) Source #
The change description of the component.
componentSummary_dateCreated :: Lens' ComponentSummary (Maybe Text) Source #
The date that the component was created.
componentSummary_description :: Lens' ComponentSummary (Maybe Text) Source #
The description of the component.
componentSummary_name :: Lens' ComponentSummary (Maybe Text) Source #
The name of the component.
componentSummary_owner :: Lens' ComponentSummary (Maybe Text) Source #
The owner of the component.
componentSummary_platform :: Lens' ComponentSummary (Maybe Platform) Source #
The platform of the component.
componentSummary_state :: Lens' ComponentSummary (Maybe ComponentState) Source #
Describes the current status of the component.
componentSummary_supportedOsVersions :: Lens' ComponentSummary (Maybe (NonEmpty Text)) Source #
The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.
componentSummary_tags :: Lens' ComponentSummary (Maybe (HashMap Text Text)) Source #
The tags associated with the component.
componentSummary_type :: Lens' ComponentSummary (Maybe ComponentType) Source #
The type of the component denotes whether the component is used to build the image or only to test it.
componentSummary_version :: Lens' ComponentSummary (Maybe Text) Source #
The version of the component.
ComponentVersion
data ComponentVersion Source #
The defining characteristics of a specific version of an Amazon Web Services TOE component.
See: newComponentVersion smart constructor.
Constructors
| ComponentVersion' | |
Fields
| |
Instances
newComponentVersion :: ComponentVersion Source #
Create a value of ComponentVersion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ComponentVersion', componentVersion_arn - The Amazon Resource Name (ARN) of the component.
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
- Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
- Version ARNs have only the first three nodes: <major>.<minor>.<patch>
- Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
$sel:dateCreated:ComponentVersion', componentVersion_dateCreated - The date that the component was created.
$sel:description:ComponentVersion', componentVersion_description - The description of the component.
$sel:name:ComponentVersion', componentVersion_name - The name of the component.
$sel:owner:ComponentVersion', componentVersion_owner - The owner of the component.
$sel:platform:ComponentVersion', componentVersion_platform - The platform of the component.
$sel:supportedOsVersions:ComponentVersion', componentVersion_supportedOsVersions - he operating system (OS) version supported by the component. If the OS
information is available, a prefix match is performed against the base
image OS version during image recipe creation.
$sel:type':ComponentVersion', componentVersion_type - The type of the component denotes whether the component is used to build
the image or only to test it.
$sel:version:ComponentVersion', componentVersion_version - The semantic version of the component.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
componentVersion_arn :: Lens' ComponentVersion (Maybe Text) Source #
The Amazon Resource Name (ARN) of the component.
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
- Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
- Version ARNs have only the first three nodes: <major>.<minor>.<patch>
- Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
componentVersion_dateCreated :: Lens' ComponentVersion (Maybe Text) Source #
The date that the component was created.
componentVersion_description :: Lens' ComponentVersion (Maybe Text) Source #
The description of the component.
componentVersion_name :: Lens' ComponentVersion (Maybe Text) Source #
The name of the component.
componentVersion_owner :: Lens' ComponentVersion (Maybe Text) Source #
The owner of the component.
componentVersion_platform :: Lens' ComponentVersion (Maybe Platform) Source #
The platform of the component.
componentVersion_supportedOsVersions :: Lens' ComponentVersion (Maybe (NonEmpty Text)) Source #
he operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.
componentVersion_type :: Lens' ComponentVersion (Maybe ComponentType) Source #
The type of the component denotes whether the component is used to build the image or only to test it.
componentVersion_version :: Lens' ComponentVersion (Maybe Text) Source #
The semantic version of the component.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
Container
A container encapsulates the runtime environment for an application.
See: newContainer smart constructor.
Constructors
| Container' | |
Instances
| FromJSON Container Source # | |
| Generic Container Source # | |
| Read Container Source # | |
| Show Container Source # | |
| NFData Container Source # | |
Defined in Amazonka.ImageBuilder.Types.Container | |
| Eq Container Source # | |
| Hashable Container Source # | |
Defined in Amazonka.ImageBuilder.Types.Container | |
| type Rep Container Source # | |
Defined in Amazonka.ImageBuilder.Types.Container type Rep Container = D1 ('MetaData "Container" "Amazonka.ImageBuilder.Types.Container" "amazonka-imagebuilder-2.0-BBLLjX59RW72O8VbQ3vKvH" 'False) (C1 ('MetaCons "Container'" 'PrefixI 'True) (S1 ('MetaSel ('Just "imageUris") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
newContainer :: Container Source #
Create a value of Container with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:imageUris:Container', container_imageUris - A list of URIs for containers created in the context Region.
$sel:region:Container', container_region - Containers and container images are Region-specific. This is the Region
context for the container.
container_imageUris :: Lens' Container (Maybe [Text]) Source #
A list of URIs for containers created in the context Region.
container_region :: Lens' Container (Maybe Text) Source #
Containers and container images are Region-specific. This is the Region context for the container.
ContainerDistributionConfiguration
data ContainerDistributionConfiguration Source #
Container distribution settings for encryption, licensing, and sharing in a specific Region.
See: newContainerDistributionConfiguration smart constructor.
Constructors
| ContainerDistributionConfiguration' | |
Fields
| |
Instances
newContainerDistributionConfiguration Source #
Arguments
| :: TargetContainerRepository | |
| -> ContainerDistributionConfiguration |
Create a value of ContainerDistributionConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:containerTags:ContainerDistributionConfiguration', containerDistributionConfiguration_containerTags - Tags that are attached to the container distribution configuration.
$sel:description:ContainerDistributionConfiguration', containerDistributionConfiguration_description - The description of the container distribution configuration.
$sel:targetRepository:ContainerDistributionConfiguration', containerDistributionConfiguration_targetRepository - The destination repository for the container distribution configuration.
containerDistributionConfiguration_containerTags :: Lens' ContainerDistributionConfiguration (Maybe [Text]) Source #
Tags that are attached to the container distribution configuration.
containerDistributionConfiguration_description :: Lens' ContainerDistributionConfiguration (Maybe Text) Source #
The description of the container distribution configuration.
containerDistributionConfiguration_targetRepository :: Lens' ContainerDistributionConfiguration TargetContainerRepository Source #
The destination repository for the container distribution configuration.
ContainerRecipe
data ContainerRecipe Source #
A container recipe.
See: newContainerRecipe smart constructor.
Constructors
| ContainerRecipe' | |
Fields
| |
Instances
newContainerRecipe :: ContainerRecipe Source #
Create a value of ContainerRecipe with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ContainerRecipe', containerRecipe_arn - The Amazon Resource Name (ARN) of the container recipe.
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
- Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
- Version ARNs have only the first three nodes: <major>.<minor>.<patch>
- Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
$sel:components:ContainerRecipe', containerRecipe_components - Components for build and test that are included in the container recipe.
$sel:containerType:ContainerRecipe', containerRecipe_containerType - Specifies the type of container, such as Docker.
$sel:dateCreated:ContainerRecipe', containerRecipe_dateCreated - The date when this container recipe was created.
$sel:description:ContainerRecipe', containerRecipe_description - The description of the container recipe.
$sel:dockerfileTemplateData:ContainerRecipe', containerRecipe_dockerfileTemplateData - Dockerfiles are text documents that are used to build Docker containers,
and ensure that they contain all of the elements required by the
application running inside. The template data consists of contextual
variables where Image Builder places build information or scripts, based
on your container image recipe.
$sel:encrypted:ContainerRecipe', containerRecipe_encrypted - A flag that indicates if the target container is encrypted.
$sel:instanceConfiguration:ContainerRecipe', containerRecipe_instanceConfiguration - A group of options that can be used to configure an instance for
building and testing container images.
$sel:kmsKeyId:ContainerRecipe', containerRecipe_kmsKeyId - Identifies which KMS key is used to encrypt the container image for
distribution to the target Region.
$sel:name:ContainerRecipe', containerRecipe_name - The name of the container recipe.
$sel:owner:ContainerRecipe', containerRecipe_owner - The owner of the container recipe.
$sel:parentImage:ContainerRecipe', containerRecipe_parentImage - The base image for the container recipe.
$sel:platform:ContainerRecipe', containerRecipe_platform - The system platform for the container, such as Windows or Linux.
$sel:tags:ContainerRecipe', containerRecipe_tags - Tags that are attached to the container recipe.
$sel:targetRepository:ContainerRecipe', containerRecipe_targetRepository - The destination repository for the container image.
$sel:version:ContainerRecipe', containerRecipe_version - The semantic version of the container recipe.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
$sel:workingDirectory:ContainerRecipe', containerRecipe_workingDirectory - The working directory for use during build and test workflows.
containerRecipe_arn :: Lens' ContainerRecipe (Maybe Text) Source #
The Amazon Resource Name (ARN) of the container recipe.
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
- Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
- Version ARNs have only the first three nodes: <major>.<minor>.<patch>
- Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
containerRecipe_components :: Lens' ContainerRecipe (Maybe (NonEmpty ComponentConfiguration)) Source #
Components for build and test that are included in the container recipe.
containerRecipe_containerType :: Lens' ContainerRecipe (Maybe ContainerType) Source #
Specifies the type of container, such as Docker.
containerRecipe_dateCreated :: Lens' ContainerRecipe (Maybe Text) Source #
The date when this container recipe was created.
containerRecipe_description :: Lens' ContainerRecipe (Maybe Text) Source #
The description of the container recipe.
containerRecipe_dockerfileTemplateData :: Lens' ContainerRecipe (Maybe Text) Source #
Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.
containerRecipe_encrypted :: Lens' ContainerRecipe (Maybe Bool) Source #
A flag that indicates if the target container is encrypted.
containerRecipe_instanceConfiguration :: Lens' ContainerRecipe (Maybe InstanceConfiguration) Source #
A group of options that can be used to configure an instance for building and testing container images.
containerRecipe_kmsKeyId :: Lens' ContainerRecipe (Maybe Text) Source #
Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
containerRecipe_name :: Lens' ContainerRecipe (Maybe Text) Source #
The name of the container recipe.
containerRecipe_owner :: Lens' ContainerRecipe (Maybe Text) Source #
The owner of the container recipe.
containerRecipe_parentImage :: Lens' ContainerRecipe (Maybe Text) Source #
The base image for the container recipe.
containerRecipe_platform :: Lens' ContainerRecipe (Maybe Platform) Source #
The system platform for the container, such as Windows or Linux.
containerRecipe_tags :: Lens' ContainerRecipe (Maybe (HashMap Text Text)) Source #
Tags that are attached to the container recipe.
containerRecipe_targetRepository :: Lens' ContainerRecipe (Maybe TargetContainerRepository) Source #
The destination repository for the container image.
containerRecipe_version :: Lens' ContainerRecipe (Maybe Text) Source #
The semantic version of the container recipe.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
containerRecipe_workingDirectory :: Lens' ContainerRecipe (Maybe Text) Source #
The working directory for use during build and test workflows.
ContainerRecipeSummary
data ContainerRecipeSummary Source #
A summary of a container recipe
See: newContainerRecipeSummary smart constructor.
Constructors
| ContainerRecipeSummary' | |
Fields
| |
Instances
newContainerRecipeSummary :: ContainerRecipeSummary Source #
Create a value of ContainerRecipeSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ContainerRecipeSummary', containerRecipeSummary_arn - The Amazon Resource Name (ARN) of the container recipe.
$sel:containerType:ContainerRecipeSummary', containerRecipeSummary_containerType - Specifies the type of container, such as "Docker".
$sel:dateCreated:ContainerRecipeSummary', containerRecipeSummary_dateCreated - The date when this container recipe was created.
$sel:name:ContainerRecipeSummary', containerRecipeSummary_name - The name of the container recipe.
$sel:owner:ContainerRecipeSummary', containerRecipeSummary_owner - The owner of the container recipe.
$sel:parentImage:ContainerRecipeSummary', containerRecipeSummary_parentImage - The base image for the container recipe.
$sel:platform:ContainerRecipeSummary', containerRecipeSummary_platform - The system platform for the container, such as Windows or Linux.
$sel:tags:ContainerRecipeSummary', containerRecipeSummary_tags - Tags that are attached to the container recipe.
containerRecipeSummary_arn :: Lens' ContainerRecipeSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the container recipe.
containerRecipeSummary_containerType :: Lens' ContainerRecipeSummary (Maybe ContainerType) Source #
Specifies the type of container, such as "Docker".
containerRecipeSummary_dateCreated :: Lens' ContainerRecipeSummary (Maybe Text) Source #
The date when this container recipe was created.
containerRecipeSummary_name :: Lens' ContainerRecipeSummary (Maybe Text) Source #
The name of the container recipe.
containerRecipeSummary_owner :: Lens' ContainerRecipeSummary (Maybe Text) Source #
The owner of the container recipe.
containerRecipeSummary_parentImage :: Lens' ContainerRecipeSummary (Maybe Text) Source #
The base image for the container recipe.
containerRecipeSummary_platform :: Lens' ContainerRecipeSummary (Maybe Platform) Source #
The system platform for the container, such as Windows or Linux.
containerRecipeSummary_tags :: Lens' ContainerRecipeSummary (Maybe (HashMap Text Text)) Source #
Tags that are attached to the container recipe.
Distribution
data Distribution Source #
Defines the settings for a specific Region.
See: newDistribution smart constructor.
Constructors
| Distribution' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Distribution |
Create a value of Distribution with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:amiDistributionConfiguration:Distribution', distribution_amiDistributionConfiguration - The specific AMI settings; for example, launch permissions or AMI tags.
$sel:containerDistributionConfiguration:Distribution', distribution_containerDistributionConfiguration - Container distribution settings for encryption, licensing, and sharing
in a specific Region.
$sel:fastLaunchConfigurations:Distribution', distribution_fastLaunchConfigurations - The Windows faster-launching configurations to use for AMI distribution.
$sel:launchTemplateConfigurations:Distribution', distribution_launchTemplateConfigurations - A group of launchTemplateConfiguration settings that apply to image
distribution for specified accounts.
$sel:licenseConfigurationArns:Distribution', distribution_licenseConfigurationArns - The License Manager Configuration to associate with the AMI in the
specified Region.
$sel:s3ExportConfiguration:Distribution', distribution_s3ExportConfiguration - 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.
$sel:region:Distribution', distribution_region - The target Region.
distribution_amiDistributionConfiguration :: Lens' Distribution (Maybe AmiDistributionConfiguration) Source #
The specific AMI settings; for example, launch permissions or AMI tags.
distribution_containerDistributionConfiguration :: Lens' Distribution (Maybe ContainerDistributionConfiguration) Source #
Container distribution settings for encryption, licensing, and sharing in a specific Region.
distribution_fastLaunchConfigurations :: Lens' Distribution (Maybe (NonEmpty FastLaunchConfiguration)) Source #
The Windows faster-launching configurations to use for AMI distribution.
distribution_launchTemplateConfigurations :: Lens' Distribution (Maybe (NonEmpty LaunchTemplateConfiguration)) Source #
A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts.
distribution_licenseConfigurationArns :: Lens' Distribution (Maybe (NonEmpty Text)) Source #
The License Manager Configuration to associate with the AMI in the specified Region.
distribution_s3ExportConfiguration :: Lens' Distribution (Maybe S3ExportConfiguration) Source #
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.
distribution_region :: Lens' Distribution Text Source #
The target Region.
DistributionConfiguration
data DistributionConfiguration Source #
A distribution configuration.
See: newDistributionConfiguration smart constructor.
Constructors
| DistributionConfiguration' | |
Fields
| |
Instances
newDistributionConfiguration Source #
Create a value of DistributionConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:DistributionConfiguration', distributionConfiguration_arn - The Amazon Resource Name (ARN) of the distribution configuration.
$sel:dateCreated:DistributionConfiguration', distributionConfiguration_dateCreated - The date on which this distribution configuration was created.
$sel:dateUpdated:DistributionConfiguration', distributionConfiguration_dateUpdated - The date on which this distribution configuration was last updated.
$sel:description:DistributionConfiguration', distributionConfiguration_description - The description of the distribution configuration.
$sel:distributions:DistributionConfiguration', distributionConfiguration_distributions - The distribution objects that apply Region-specific settings for the
deployment of the image to targeted Regions.
$sel:name:DistributionConfiguration', distributionConfiguration_name - The name of the distribution configuration.
$sel:tags:DistributionConfiguration', distributionConfiguration_tags - The tags of the distribution configuration.
$sel:timeoutMinutes:DistributionConfiguration', distributionConfiguration_timeoutMinutes - The maximum duration in minutes for this distribution configuration.
distributionConfiguration_arn :: Lens' DistributionConfiguration (Maybe Text) Source #
The Amazon Resource Name (ARN) of the distribution configuration.
distributionConfiguration_dateCreated :: Lens' DistributionConfiguration (Maybe Text) Source #
The date on which this distribution configuration was created.
distributionConfiguration_dateUpdated :: Lens' DistributionConfiguration (Maybe Text) Source #
The date on which this distribution configuration was last updated.
distributionConfiguration_description :: Lens' DistributionConfiguration (Maybe Text) Source #
The description of the distribution configuration.
distributionConfiguration_distributions :: Lens' DistributionConfiguration (Maybe [Distribution]) Source #
The distribution objects that apply Region-specific settings for the deployment of the image to targeted Regions.
distributionConfiguration_name :: Lens' DistributionConfiguration (Maybe Text) Source #
The name of the distribution configuration.
distributionConfiguration_tags :: Lens' DistributionConfiguration (Maybe (HashMap Text Text)) Source #
The tags of the distribution configuration.
distributionConfiguration_timeoutMinutes :: Lens' DistributionConfiguration Natural Source #
The maximum duration in minutes for this distribution configuration.
DistributionConfigurationSummary
data DistributionConfigurationSummary Source #
A high-level overview of a distribution configuration.
See: newDistributionConfigurationSummary smart constructor.
Constructors
| DistributionConfigurationSummary' | |
Fields
| |
Instances
newDistributionConfigurationSummary :: DistributionConfigurationSummary Source #
Create a value of DistributionConfigurationSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:DistributionConfigurationSummary', distributionConfigurationSummary_arn - The Amazon Resource Name (ARN) of the distribution configuration.
$sel:dateCreated:DistributionConfigurationSummary', distributionConfigurationSummary_dateCreated - The date on which the distribution configuration was created.
$sel:dateUpdated:DistributionConfigurationSummary', distributionConfigurationSummary_dateUpdated - The date on which the distribution configuration was updated.
$sel:description:DistributionConfigurationSummary', distributionConfigurationSummary_description - The description of the distribution configuration.
$sel:name:DistributionConfigurationSummary', distributionConfigurationSummary_name - The name of the distribution configuration.
$sel:regions:DistributionConfigurationSummary', distributionConfigurationSummary_regions - A list of Regions where the container image is distributed to.
$sel:tags:DistributionConfigurationSummary', distributionConfigurationSummary_tags - The tags associated with the distribution configuration.
distributionConfigurationSummary_arn :: Lens' DistributionConfigurationSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the distribution configuration.
distributionConfigurationSummary_dateCreated :: Lens' DistributionConfigurationSummary (Maybe Text) Source #
The date on which the distribution configuration was created.
distributionConfigurationSummary_dateUpdated :: Lens' DistributionConfigurationSummary (Maybe Text) Source #
The date on which the distribution configuration was updated.
distributionConfigurationSummary_description :: Lens' DistributionConfigurationSummary (Maybe Text) Source #
The description of the distribution configuration.
distributionConfigurationSummary_name :: Lens' DistributionConfigurationSummary (Maybe Text) Source #
The name of the distribution configuration.
distributionConfigurationSummary_regions :: Lens' DistributionConfigurationSummary (Maybe [Text]) Source #
A list of Regions where the container image is distributed to.
distributionConfigurationSummary_tags :: Lens' DistributionConfigurationSummary (Maybe (HashMap Text Text)) Source #
The tags associated with the distribution configuration.
EbsInstanceBlockDeviceSpecification
data EbsInstanceBlockDeviceSpecification Source #
Amazon EBS-specific block device mapping specifications.
See: newEbsInstanceBlockDeviceSpecification smart constructor.
Constructors
| EbsInstanceBlockDeviceSpecification' | |
Fields
| |
Instances
newEbsInstanceBlockDeviceSpecification :: EbsInstanceBlockDeviceSpecification Source #
Create a value of EbsInstanceBlockDeviceSpecification with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deleteOnTermination:EbsInstanceBlockDeviceSpecification', ebsInstanceBlockDeviceSpecification_deleteOnTermination - Use to configure delete on termination of the associated device.
$sel:encrypted:EbsInstanceBlockDeviceSpecification', ebsInstanceBlockDeviceSpecification_encrypted - Use to configure device encryption.
$sel:iops:EbsInstanceBlockDeviceSpecification', ebsInstanceBlockDeviceSpecification_iops - Use to configure device IOPS.
$sel:kmsKeyId:EbsInstanceBlockDeviceSpecification', ebsInstanceBlockDeviceSpecification_kmsKeyId - Use to configure the KMS key to use when encrypting the device.
$sel:snapshotId:EbsInstanceBlockDeviceSpecification', ebsInstanceBlockDeviceSpecification_snapshotId - The snapshot that defines the device contents.
$sel:throughput:EbsInstanceBlockDeviceSpecification', ebsInstanceBlockDeviceSpecification_throughput - For GP3 volumes only – The throughput in MiB/s that the volume
supports.
$sel:volumeSize:EbsInstanceBlockDeviceSpecification', ebsInstanceBlockDeviceSpecification_volumeSize - Use to override the device's volume size.
$sel:volumeType:EbsInstanceBlockDeviceSpecification', ebsInstanceBlockDeviceSpecification_volumeType - Use to override the device's volume type.
ebsInstanceBlockDeviceSpecification_deleteOnTermination :: Lens' EbsInstanceBlockDeviceSpecification (Maybe Bool) Source #
Use to configure delete on termination of the associated device.
ebsInstanceBlockDeviceSpecification_encrypted :: Lens' EbsInstanceBlockDeviceSpecification (Maybe Bool) Source #
Use to configure device encryption.
ebsInstanceBlockDeviceSpecification_iops :: Lens' EbsInstanceBlockDeviceSpecification (Maybe Natural) Source #
Use to configure device IOPS.
ebsInstanceBlockDeviceSpecification_kmsKeyId :: Lens' EbsInstanceBlockDeviceSpecification (Maybe Text) Source #
Use to configure the KMS key to use when encrypting the device.
ebsInstanceBlockDeviceSpecification_snapshotId :: Lens' EbsInstanceBlockDeviceSpecification (Maybe Text) Source #
The snapshot that defines the device contents.
ebsInstanceBlockDeviceSpecification_throughput :: Lens' EbsInstanceBlockDeviceSpecification (Maybe Natural) Source #
For GP3 volumes only – The throughput in MiB/s that the volume supports.
ebsInstanceBlockDeviceSpecification_volumeSize :: Lens' EbsInstanceBlockDeviceSpecification (Maybe Natural) Source #
Use to override the device's volume size.
ebsInstanceBlockDeviceSpecification_volumeType :: Lens' EbsInstanceBlockDeviceSpecification (Maybe EbsVolumeType) Source #
Use to override the device's volume type.
FastLaunchConfiguration
data FastLaunchConfiguration Source #
Define and configure faster launching for output Windows AMIs.
See: newFastLaunchConfiguration smart constructor.
Constructors
| FastLaunchConfiguration' | |
Fields
| |
Instances
newFastLaunchConfiguration Source #
Create a value of FastLaunchConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:FastLaunchConfiguration', fastLaunchConfiguration_accountId - The owner account ID for the fast-launch enabled Windows AMI.
$sel:launchTemplate:FastLaunchConfiguration', fastLaunchConfiguration_launchTemplate - The launch template that the fast-launch enabled Windows AMI uses when
it launches Windows instances to create pre-provisioned snapshots.
$sel:maxParallelLaunches:FastLaunchConfiguration', fastLaunchConfiguration_maxParallelLaunches - The maximum number of parallel instances that are launched for creating
resources.
$sel:snapshotConfiguration:FastLaunchConfiguration', fastLaunchConfiguration_snapshotConfiguration - Configuration settings for managing the number of snapshots that are
created from pre-provisioned instances for the Windows AMI when faster
launching is enabled.
$sel:enabled:FastLaunchConfiguration', fastLaunchConfiguration_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.
fastLaunchConfiguration_accountId :: Lens' FastLaunchConfiguration (Maybe Text) Source #
The owner account ID for the fast-launch enabled Windows AMI.
fastLaunchConfiguration_launchTemplate :: Lens' FastLaunchConfiguration (Maybe FastLaunchLaunchTemplateSpecification) Source #
The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.
fastLaunchConfiguration_maxParallelLaunches :: Lens' FastLaunchConfiguration (Maybe Natural) Source #
The maximum number of parallel instances that are launched for creating resources.
fastLaunchConfiguration_snapshotConfiguration :: Lens' FastLaunchConfiguration (Maybe FastLaunchSnapshotConfiguration) Source #
Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.
fastLaunchConfiguration_enabled :: Lens' FastLaunchConfiguration Bool Source #
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.
FastLaunchLaunchTemplateSpecification
data FastLaunchLaunchTemplateSpecification Source #
Identifies the launch template that the associated Windows AMI uses for launching an instance when faster launching is enabled.
You can specify either the launchTemplateName or the
launchTemplateId, but not both.
See: newFastLaunchLaunchTemplateSpecification smart constructor.
Constructors
| FastLaunchLaunchTemplateSpecification' | |
Fields
| |
Instances
newFastLaunchLaunchTemplateSpecification :: FastLaunchLaunchTemplateSpecification Source #
Create a value of FastLaunchLaunchTemplateSpecification with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:launchTemplateId:FastLaunchLaunchTemplateSpecification', fastLaunchLaunchTemplateSpecification_launchTemplateId - The ID of the launch template to use for faster launching for a Windows
AMI.
$sel:launchTemplateName:FastLaunchLaunchTemplateSpecification', fastLaunchLaunchTemplateSpecification_launchTemplateName - The name of the launch template to use for faster launching for a
Windows AMI.
$sel:launchTemplateVersion:FastLaunchLaunchTemplateSpecification', fastLaunchLaunchTemplateSpecification_launchTemplateVersion - The version of the launch template to use for faster launching for a
Windows AMI.
fastLaunchLaunchTemplateSpecification_launchTemplateId :: Lens' FastLaunchLaunchTemplateSpecification (Maybe Text) Source #
The ID of the launch template to use for faster launching for a Windows AMI.
fastLaunchLaunchTemplateSpecification_launchTemplateName :: Lens' FastLaunchLaunchTemplateSpecification (Maybe Text) Source #
The name of the launch template to use for faster launching for a Windows AMI.
fastLaunchLaunchTemplateSpecification_launchTemplateVersion :: Lens' FastLaunchLaunchTemplateSpecification (Maybe Text) Source #
The version of the launch template to use for faster launching for a Windows AMI.
FastLaunchSnapshotConfiguration
data FastLaunchSnapshotConfiguration Source #
Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.
See: newFastLaunchSnapshotConfiguration smart constructor.
Constructors
| FastLaunchSnapshotConfiguration' | |
Fields
| |
Instances
newFastLaunchSnapshotConfiguration :: FastLaunchSnapshotConfiguration Source #
Create a value of FastLaunchSnapshotConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:targetResourceCount:FastLaunchSnapshotConfiguration', fastLaunchSnapshotConfiguration_targetResourceCount - The number of pre-provisioned snapshots to keep on hand for a
fast-launch enabled Windows AMI.
fastLaunchSnapshotConfiguration_targetResourceCount :: Lens' FastLaunchSnapshotConfiguration (Maybe Natural) Source #
The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.
Filter
A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
See: newFilter smart constructor.
Constructors
| Filter' | |
Instances
| ToJSON Filter Source # | |
Defined in Amazonka.ImageBuilder.Types.Filter | |
| Generic Filter Source # | |
| Read Filter Source # | |
| Show Filter Source # | |
| NFData Filter Source # | |
Defined in Amazonka.ImageBuilder.Types.Filter | |
| Eq Filter Source # | |
| Hashable Filter Source # | |
Defined in Amazonka.ImageBuilder.Types.Filter | |
| type Rep Filter Source # | |
Defined in Amazonka.ImageBuilder.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.ImageBuilder.Types.Filter" "amazonka-imagebuilder-2.0-BBLLjX59RW72O8VbQ3vKvH" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))))) | |
Create a value of Filter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:Filter', filter_name - The name of the filter. Filter names are case-sensitive.
$sel:values:Filter', filter_values - The filter values. Filter values are case-sensitive.
filter_name :: Lens' Filter (Maybe Text) Source #
The name of the filter. Filter names are case-sensitive.
filter_values :: Lens' Filter (Maybe (NonEmpty Text)) Source #
The filter values. Filter values are case-sensitive.
Image
An Image Builder image. You must specify exactly one recipe for the
image – either a container recipe (containerRecipe), which creates a
container image, or an image recipe (imageRecipe), which creates an
AMI.
See: newImage smart constructor.
Constructors
| Image' | |
Fields
| |
Instances
Create a value of Image with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
Image, image_arn - The Amazon Resource Name (ARN) of the image.
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
- Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
- Version ARNs have only the first three nodes: <major>.<minor>.<patch>
- Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
$sel:buildType:Image', image_buildType - Indicates the type of build that created this image. The build can be
initiated in the following ways:
- USER_INITIATED – A manual pipeline build request.
- SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
- IMPORT – A VM import created the image to use as the base image for the recipe.
$sel:containerRecipe:Image', image_containerRecipe - The recipe that is used to create an Image Builder container image.
Image, image_dateCreated - The date on which this image was created.
$sel:distributionConfiguration:Image', image_distributionConfiguration - The distribution configuration used when creating this image.
$sel:enhancedImageMetadataEnabled:Image', image_enhancedImageMetadataEnabled - Collects additional information about the image being created, including
the operating system (OS) version and package list. This information is
used to enhance the overall experience of using EC2 Image Builder.
Enabled by default.
$sel:imageRecipe:Image', image_imageRecipe - The image recipe used when creating the image.
$sel:imageTestsConfiguration:Image', image_imageTestsConfiguration - The image tests configuration used when creating this image.
$sel:infrastructureConfiguration:Image', image_infrastructureConfiguration - The infrastructure used when creating this image.
Image, image_name - The name of the image.
$sel:osVersion:Image', image_osVersion - The operating system version of the instance. For example, Amazon Linux
2, Ubuntu 18, or Microsoft Windows Server 2019.
$sel:outputResources:Image', image_outputResources - The output resources produced when creating this image.
Image, image_platform - The platform of the image.
$sel:sourcePipelineArn:Image', image_sourcePipelineArn - The Amazon Resource Name (ARN) of the image pipeline that created this
image.
$sel:sourcePipelineName:Image', image_sourcePipelineName - The name of the image pipeline that created this image.
$sel:state:Image', image_state - The state of the image.
Image, image_tags - The tags of the image.
Image, image_type - Specifies whether this is an AMI or container image.
Image, image_version - The semantic version of the image.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
image_arn :: Lens' Image (Maybe Text) Source #
The Amazon Resource Name (ARN) of the image.
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
- Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
- Version ARNs have only the first three nodes: <major>.<minor>.<patch>
- Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
image_buildType :: Lens' Image (Maybe BuildType) Source #
Indicates the type of build that created this image. The build can be initiated in the following ways:
- USER_INITIATED – A manual pipeline build request.
- SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
- IMPORT – A VM import created the image to use as the base image for the recipe.
image_containerRecipe :: Lens' Image (Maybe ContainerRecipe) Source #
The recipe that is used to create an Image Builder container image.
image_distributionConfiguration :: Lens' Image (Maybe DistributionConfiguration) Source #
The distribution configuration used when creating this image.
image_enhancedImageMetadataEnabled :: Lens' Image (Maybe Bool) Source #
Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
image_imageRecipe :: Lens' Image (Maybe ImageRecipe) Source #
The image recipe used when creating the image.
image_imageTestsConfiguration :: Lens' Image (Maybe ImageTestsConfiguration) Source #
The image tests configuration used when creating this image.
image_infrastructureConfiguration :: Lens' Image (Maybe InfrastructureConfiguration) Source #
The infrastructure used when creating this image.
image_osVersion :: Lens' Image (Maybe Text) Source #
The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
image_outputResources :: Lens' Image (Maybe OutputResources) Source #
The output resources produced when creating this image.
image_sourcePipelineArn :: Lens' Image (Maybe Text) Source #
The Amazon Resource Name (ARN) of the image pipeline that created this image.
image_sourcePipelineName :: Lens' Image (Maybe Text) Source #
The name of the image pipeline that created this image.
image_state :: Lens' Image (Maybe ImageState) Source #
The state of the image.
image_type :: Lens' Image (Maybe ImageType) Source #
Specifies whether this is an AMI or container image.
image_version :: Lens' Image (Maybe Text) Source #
The semantic version of the image.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
ImagePackage
data ImagePackage Source #
Represents a package installed on an Image Builder image.
See: newImagePackage smart constructor.
Constructors
| ImagePackage' | |
Fields
| |
Instances
newImagePackage :: ImagePackage Source #
Create a value of ImagePackage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:packageName:ImagePackage', imagePackage_packageName - The name of the package as reported to the operating system package
manager.
$sel:packageVersion:ImagePackage', imagePackage_packageVersion - The version of the package as reported to the operating system package
manager.
imagePackage_packageName :: Lens' ImagePackage (Maybe Text) Source #
The name of the package as reported to the operating system package manager.
imagePackage_packageVersion :: Lens' ImagePackage (Maybe Text) Source #
The version of the package as reported to the operating system package manager.
ImagePipeline
data ImagePipeline Source #
Details of an image pipeline.
See: newImagePipeline smart constructor.
Constructors
| ImagePipeline' | |
Fields
| |
Instances
newImagePipeline :: ImagePipeline Source #
Create a value of ImagePipeline with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ImagePipeline', imagePipeline_arn - The Amazon Resource Name (ARN) of the image pipeline.
$sel:containerRecipeArn:ImagePipeline', imagePipeline_containerRecipeArn - The Amazon Resource Name (ARN) of the container recipe that is used for
this pipeline.
$sel:dateCreated:ImagePipeline', imagePipeline_dateCreated - The date on which this image pipeline was created.
$sel:dateLastRun:ImagePipeline', imagePipeline_dateLastRun - The date on which this image pipeline was last run.
$sel:dateNextRun:ImagePipeline', imagePipeline_dateNextRun - The date on which this image pipeline will next be run.
$sel:dateUpdated:ImagePipeline', imagePipeline_dateUpdated - The date on which this image pipeline was last updated.
$sel:description:ImagePipeline', imagePipeline_description - The description of the image pipeline.
$sel:distributionConfigurationArn:ImagePipeline', imagePipeline_distributionConfigurationArn - The Amazon Resource Name (ARN) of the distribution configuration
associated with this image pipeline.
$sel:enhancedImageMetadataEnabled:ImagePipeline', imagePipeline_enhancedImageMetadataEnabled - Collects additional information about the image being created, including
the operating system (OS) version and package list. This information is
used to enhance the overall experience of using EC2 Image Builder.
Enabled by default.
$sel:imageRecipeArn:ImagePipeline', imagePipeline_imageRecipeArn - The Amazon Resource Name (ARN) of the image recipe associated with this
image pipeline.
$sel:imageTestsConfiguration:ImagePipeline', imagePipeline_imageTestsConfiguration - The image tests configuration of the image pipeline.
$sel:infrastructureConfigurationArn:ImagePipeline', imagePipeline_infrastructureConfigurationArn - The Amazon Resource Name (ARN) of the infrastructure configuration
associated with this image pipeline.
$sel:name:ImagePipeline', imagePipeline_name - The name of the image pipeline.
$sel:platform:ImagePipeline', imagePipeline_platform - The platform of the image pipeline.
$sel:schedule:ImagePipeline', imagePipeline_schedule - The schedule of the image pipeline.
$sel:status:ImagePipeline', imagePipeline_status - The status of the image pipeline.
$sel:tags:ImagePipeline', imagePipeline_tags - The tags of this image pipeline.
imagePipeline_arn :: Lens' ImagePipeline (Maybe Text) Source #
The Amazon Resource Name (ARN) of the image pipeline.
imagePipeline_containerRecipeArn :: Lens' ImagePipeline (Maybe Text) Source #
The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
imagePipeline_dateCreated :: Lens' ImagePipeline (Maybe Text) Source #
The date on which this image pipeline was created.
imagePipeline_dateLastRun :: Lens' ImagePipeline (Maybe Text) Source #
The date on which this image pipeline was last run.
imagePipeline_dateNextRun :: Lens' ImagePipeline (Maybe Text) Source #
The date on which this image pipeline will next be run.
imagePipeline_dateUpdated :: Lens' ImagePipeline (Maybe Text) Source #
The date on which this image pipeline was last updated.
imagePipeline_description :: Lens' ImagePipeline (Maybe Text) Source #
The description of the image pipeline.
imagePipeline_distributionConfigurationArn :: Lens' ImagePipeline (Maybe Text) Source #
The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
imagePipeline_enhancedImageMetadataEnabled :: Lens' ImagePipeline (Maybe Bool) Source #
Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
imagePipeline_imageRecipeArn :: Lens' ImagePipeline (Maybe Text) Source #
The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
imagePipeline_imageTestsConfiguration :: Lens' ImagePipeline (Maybe ImageTestsConfiguration) Source #
The image tests configuration of the image pipeline.
imagePipeline_infrastructureConfigurationArn :: Lens' ImagePipeline (Maybe Text) Source #
The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
imagePipeline_name :: Lens' ImagePipeline (Maybe Text) Source #
The name of the image pipeline.
imagePipeline_platform :: Lens' ImagePipeline (Maybe Platform) Source #
The platform of the image pipeline.
imagePipeline_schedule :: Lens' ImagePipeline (Maybe Schedule) Source #
The schedule of the image pipeline.
imagePipeline_status :: Lens' ImagePipeline (Maybe PipelineStatus) Source #
The status of the image pipeline.
imagePipeline_tags :: Lens' ImagePipeline (Maybe (HashMap Text Text)) Source #
The tags of this image pipeline.
ImageRecipe
data ImageRecipe Source #
An image recipe.
See: newImageRecipe smart constructor.
Constructors
| ImageRecipe' | |
Fields
| |
Instances
newImageRecipe :: ImageRecipe Source #
Create a value of ImageRecipe with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:additionalInstanceConfiguration:ImageRecipe', imageRecipe_additionalInstanceConfiguration - Before you create a new AMI, Image Builder launches temporary Amazon EC2
instances to build and test your image configuration. Instance
configuration adds a layer of control over those instances. You can
define settings and add scripts to run when an instance is launched from
your AMI.
$sel:arn:ImageRecipe', imageRecipe_arn - The Amazon Resource Name (ARN) of the image recipe.
$sel:blockDeviceMappings:ImageRecipe', imageRecipe_blockDeviceMappings - The block device mappings to apply when creating images from this
recipe.
$sel:components:ImageRecipe', imageRecipe_components - The components of the image recipe.
$sel:dateCreated:ImageRecipe', imageRecipe_dateCreated - The date on which this image recipe was created.
$sel:description:ImageRecipe', imageRecipe_description - The description of the image recipe.
$sel:name:ImageRecipe', imageRecipe_name - The name of the image recipe.
$sel:owner:ImageRecipe', imageRecipe_owner - The owner of the image recipe.
$sel:parentImage:ImageRecipe', imageRecipe_parentImage - The base image of the image recipe.
$sel:platform:ImageRecipe', imageRecipe_platform - The platform of the image recipe.
$sel:tags:ImageRecipe', imageRecipe_tags - The tags of the image recipe.
$sel:type':ImageRecipe', imageRecipe_type - Specifies which type of image is created by the recipe - an AMI or a
container image.
$sel:version:ImageRecipe', imageRecipe_version - The version of the image recipe.
$sel:workingDirectory:ImageRecipe', imageRecipe_workingDirectory - The working directory to be used during build and test workflows.
imageRecipe_additionalInstanceConfiguration :: Lens' ImageRecipe (Maybe AdditionalInstanceConfiguration) Source #
Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration. Instance configuration adds a layer of control over those instances. You can define settings and add scripts to run when an instance is launched from your AMI.
imageRecipe_arn :: Lens' ImageRecipe (Maybe Text) Source #
The Amazon Resource Name (ARN) of the image recipe.
imageRecipe_blockDeviceMappings :: Lens' ImageRecipe (Maybe [InstanceBlockDeviceMapping]) Source #
The block device mappings to apply when creating images from this recipe.
imageRecipe_components :: Lens' ImageRecipe (Maybe (NonEmpty ComponentConfiguration)) Source #
The components of the image recipe.
imageRecipe_dateCreated :: Lens' ImageRecipe (Maybe Text) Source #
The date on which this image recipe was created.
imageRecipe_description :: Lens' ImageRecipe (Maybe Text) Source #
The description of the image recipe.
imageRecipe_name :: Lens' ImageRecipe (Maybe Text) Source #
The name of the image recipe.
imageRecipe_owner :: Lens' ImageRecipe (Maybe Text) Source #
The owner of the image recipe.
imageRecipe_parentImage :: Lens' ImageRecipe (Maybe Text) Source #
The base image of the image recipe.
imageRecipe_platform :: Lens' ImageRecipe (Maybe Platform) Source #
The platform of the image recipe.
imageRecipe_tags :: Lens' ImageRecipe (Maybe (HashMap Text Text)) Source #
The tags of the image recipe.
imageRecipe_type :: Lens' ImageRecipe (Maybe ImageType) Source #
Specifies which type of image is created by the recipe - an AMI or a container image.
imageRecipe_version :: Lens' ImageRecipe (Maybe Text) Source #
The version of the image recipe.
imageRecipe_workingDirectory :: Lens' ImageRecipe (Maybe Text) Source #
The working directory to be used during build and test workflows.
ImageRecipeSummary
data ImageRecipeSummary Source #
A summary of an image recipe.
See: newImageRecipeSummary smart constructor.
Constructors
| ImageRecipeSummary' | |
Fields
| |
Instances
newImageRecipeSummary :: ImageRecipeSummary Source #
Create a value of ImageRecipeSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ImageRecipeSummary', imageRecipeSummary_arn - The Amazon Resource Name (ARN) of the image recipe.
$sel:dateCreated:ImageRecipeSummary', imageRecipeSummary_dateCreated - The date on which this image recipe was created.
$sel:name:ImageRecipeSummary', imageRecipeSummary_name - The name of the image recipe.
$sel:owner:ImageRecipeSummary', imageRecipeSummary_owner - The owner of the image recipe.
$sel:parentImage:ImageRecipeSummary', imageRecipeSummary_parentImage - The base image of the image recipe.
$sel:platform:ImageRecipeSummary', imageRecipeSummary_platform - The platform of the image recipe.
$sel:tags:ImageRecipeSummary', imageRecipeSummary_tags - The tags of the image recipe.
imageRecipeSummary_arn :: Lens' ImageRecipeSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the image recipe.
imageRecipeSummary_dateCreated :: Lens' ImageRecipeSummary (Maybe Text) Source #
The date on which this image recipe was created.
imageRecipeSummary_name :: Lens' ImageRecipeSummary (Maybe Text) Source #
The name of the image recipe.
imageRecipeSummary_owner :: Lens' ImageRecipeSummary (Maybe Text) Source #
The owner of the image recipe.
imageRecipeSummary_parentImage :: Lens' ImageRecipeSummary (Maybe Text) Source #
The base image of the image recipe.
imageRecipeSummary_platform :: Lens' ImageRecipeSummary (Maybe Platform) Source #
The platform of the image recipe.
imageRecipeSummary_tags :: Lens' ImageRecipeSummary (Maybe (HashMap Text Text)) Source #
The tags of the image recipe.
ImageState
data ImageState Source #
Image state shows the image status and the reason for that status.
See: newImageState smart constructor.
Constructors
| ImageState' | |
Instances
newImageState :: ImageState Source #
Create a value of ImageState with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:reason:ImageState', imageState_reason - The reason for the image's status.
$sel:status:ImageState', imageState_status - The status of the image.
imageState_reason :: Lens' ImageState (Maybe Text) Source #
The reason for the image's status.
imageState_status :: Lens' ImageState (Maybe ImageStatus) Source #
The status of the image.
ImageSummary
data ImageSummary Source #
An image summary.
See: newImageSummary smart constructor.
Constructors
| ImageSummary' | |
Fields
| |
Instances
newImageSummary :: ImageSummary Source #
Create a value of ImageSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ImageSummary', imageSummary_arn - The Amazon Resource Name (ARN) of the image.
$sel:buildType:ImageSummary', imageSummary_buildType - Indicates the type of build that created this image. The build can be
initiated in the following ways:
- USER_INITIATED – A manual pipeline build request.
- SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
- IMPORT – A VM import created the image to use as the base image for the recipe.
$sel:dateCreated:ImageSummary', imageSummary_dateCreated - The date on which this image was created.
$sel:name:ImageSummary', imageSummary_name - The name of the image.
$sel:osVersion:ImageSummary', imageSummary_osVersion - The operating system version of the instance. For example, Amazon Linux
2, Ubuntu 18, or Microsoft Windows Server 2019.
$sel:outputResources:ImageSummary', imageSummary_outputResources - The output resources produced when creating this image.
$sel:owner:ImageSummary', imageSummary_owner - The owner of the image.
$sel:platform:ImageSummary', imageSummary_platform - The platform of the image.
$sel:state:ImageSummary', imageSummary_state - The state of the image.
$sel:tags:ImageSummary', imageSummary_tags - The tags of the image.
$sel:type':ImageSummary', imageSummary_type - Specifies whether this is an AMI or container image.
$sel:version:ImageSummary', imageSummary_version - The version of the image.
imageSummary_arn :: Lens' ImageSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the image.
imageSummary_buildType :: Lens' ImageSummary (Maybe BuildType) Source #
Indicates the type of build that created this image. The build can be initiated in the following ways:
- USER_INITIATED – A manual pipeline build request.
- SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
- IMPORT – A VM import created the image to use as the base image for the recipe.
imageSummary_dateCreated :: Lens' ImageSummary (Maybe Text) Source #
The date on which this image was created.
imageSummary_name :: Lens' ImageSummary (Maybe Text) Source #
The name of the image.
imageSummary_osVersion :: Lens' ImageSummary (Maybe Text) Source #
The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
imageSummary_outputResources :: Lens' ImageSummary (Maybe OutputResources) Source #
The output resources produced when creating this image.
imageSummary_owner :: Lens' ImageSummary (Maybe Text) Source #
The owner of the image.
imageSummary_platform :: Lens' ImageSummary (Maybe Platform) Source #
The platform of the image.
imageSummary_state :: Lens' ImageSummary (Maybe ImageState) Source #
The state of the image.
imageSummary_tags :: Lens' ImageSummary (Maybe (HashMap Text Text)) Source #
The tags of the image.
imageSummary_type :: Lens' ImageSummary (Maybe ImageType) Source #
Specifies whether this is an AMI or container image.
imageSummary_version :: Lens' ImageSummary (Maybe Text) Source #
The version of the image.
ImageTestsConfiguration
data ImageTestsConfiguration Source #
Configure image tests for your pipeline build. Tests run after building the image, to verify that the AMI or container image is valid before distributing it.
See: newImageTestsConfiguration smart constructor.
Constructors
| ImageTestsConfiguration' | |
Fields
| |
Instances
newImageTestsConfiguration :: ImageTestsConfiguration Source #
Create a value of ImageTestsConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:imageTestsEnabled:ImageTestsConfiguration', imageTestsConfiguration_imageTestsEnabled - Determines if tests should run after building the image. Image Builder
defaults to enable tests to run following the image build, before image
distribution.
$sel:timeoutMinutes:ImageTestsConfiguration', imageTestsConfiguration_timeoutMinutes - The maximum time in minutes that tests are permitted to run.
imageTestsConfiguration_imageTestsEnabled :: Lens' ImageTestsConfiguration (Maybe Bool) Source #
Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.
imageTestsConfiguration_timeoutMinutes :: Lens' ImageTestsConfiguration (Maybe Natural) Source #
The maximum time in minutes that tests are permitted to run.
ImageVersion
data ImageVersion Source #
The defining characteristics of a specific version of an Image Builder image.
See: newImageVersion smart constructor.
Constructors
| ImageVersion' | |
Fields
| |
Instances
newImageVersion :: ImageVersion Source #
Create a value of ImageVersion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ImageVersion', imageVersion_arn - The Amazon Resource Name (ARN) of a specific version of an Image Builder
image.
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
- Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
- Version ARNs have only the first three nodes: <major>.<minor>.<patch>
- Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
$sel:buildType:ImageVersion', imageVersion_buildType - Indicates the type of build that created this image. The build can be
initiated in the following ways:
- USER_INITIATED – A manual pipeline build request.
- SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
- IMPORT – A VM import created the image to use as the base image for the recipe.
$sel:dateCreated:ImageVersion', imageVersion_dateCreated - The date on which this specific version of the Image Builder image was
created.
$sel:name:ImageVersion', imageVersion_name - The name of this specific version of an Image Builder image.
$sel:osVersion:ImageVersion', imageVersion_osVersion - The operating system version of the Amazon EC2 build instance. For
example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
$sel:owner:ImageVersion', imageVersion_owner - The owner of the image version.
$sel:platform:ImageVersion', imageVersion_platform - The platform of the image version, for example "Windows" or "Linux".
$sel:type':ImageVersion', imageVersion_type - Specifies whether this image is an AMI or a container image.
$sel:version:ImageVersion', imageVersion_version - Details for a specific version of an Image Builder image. This version
follows the semantic version syntax.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
imageVersion_arn :: Lens' ImageVersion (Maybe Text) Source #
The Amazon Resource Name (ARN) of a specific version of an Image Builder image.
Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
- Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
- Version ARNs have only the first three nodes: <major>.<minor>.<patch>
- Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
imageVersion_buildType :: Lens' ImageVersion (Maybe BuildType) Source #
Indicates the type of build that created this image. The build can be initiated in the following ways:
- USER_INITIATED – A manual pipeline build request.
- SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
- IMPORT – A VM import created the image to use as the base image for the recipe.
imageVersion_dateCreated :: Lens' ImageVersion (Maybe Text) Source #
The date on which this specific version of the Image Builder image was created.
imageVersion_name :: Lens' ImageVersion (Maybe Text) Source #
The name of this specific version of an Image Builder image.
imageVersion_osVersion :: Lens' ImageVersion (Maybe Text) Source #
The operating system version of the Amazon EC2 build instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
imageVersion_owner :: Lens' ImageVersion (Maybe Text) Source #
The owner of the image version.
imageVersion_platform :: Lens' ImageVersion (Maybe Platform) Source #
The platform of the image version, for example "Windows" or "Linux".
imageVersion_type :: Lens' ImageVersion (Maybe ImageType) Source #
Specifies whether this image is an AMI or a container image.
imageVersion_version :: Lens' ImageVersion (Maybe Text) Source #
Details for a specific version of an Image Builder image. This version follows the semantic version syntax.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
InfrastructureConfiguration
data InfrastructureConfiguration Source #
Details of the infrastructure configuration.
See: newInfrastructureConfiguration smart constructor.
Constructors
| InfrastructureConfiguration' | |
Fields
| |
Instances
newInfrastructureConfiguration :: InfrastructureConfiguration Source #
Create a value of InfrastructureConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:InfrastructureConfiguration', infrastructureConfiguration_arn - The Amazon Resource Name (ARN) of the infrastructure configuration.
$sel:dateCreated:InfrastructureConfiguration', infrastructureConfiguration_dateCreated - The date on which the infrastructure configuration was created.
$sel:dateUpdated:InfrastructureConfiguration', infrastructureConfiguration_dateUpdated - The date on which the infrastructure configuration was last updated.
$sel:description:InfrastructureConfiguration', infrastructureConfiguration_description - The description of the infrastructure configuration.
$sel:instanceMetadataOptions:InfrastructureConfiguration', infrastructureConfiguration_instanceMetadataOptions - The instance metadata option settings for the infrastructure
configuration.
$sel:instanceProfileName:InfrastructureConfiguration', infrastructureConfiguration_instanceProfileName - The instance profile of the infrastructure configuration.
$sel:instanceTypes:InfrastructureConfiguration', infrastructureConfiguration_instanceTypes - The instance types of the infrastructure configuration.
$sel:keyPair:InfrastructureConfiguration', infrastructureConfiguration_keyPair - The Amazon EC2 key pair of the infrastructure configuration.
$sel:logging:InfrastructureConfiguration', infrastructureConfiguration_logging - The logging configuration of the infrastructure configuration.
$sel:name:InfrastructureConfiguration', infrastructureConfiguration_name - The name of the infrastructure configuration.
$sel:resourceTags:InfrastructureConfiguration', infrastructureConfiguration_resourceTags - The tags attached to the resource created by Image Builder.
$sel:securityGroupIds:InfrastructureConfiguration', infrastructureConfiguration_securityGroupIds - The security group IDs of the infrastructure configuration.
$sel:snsTopicArn:InfrastructureConfiguration', infrastructureConfiguration_snsTopicArn - The Amazon Resource Name (ARN) for the SNS topic to which we send image
build event notifications.
EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys from other accounts. The key that is used to encrypt the SNS topic must reside in the account that the Image Builder service runs under.
$sel:subnetId:InfrastructureConfiguration', infrastructureConfiguration_subnetId - The subnet ID of the infrastructure configuration.
$sel:tags:InfrastructureConfiguration', infrastructureConfiguration_tags - The tags of the infrastructure configuration.
$sel:terminateInstanceOnFailure:InfrastructureConfiguration', infrastructureConfiguration_terminateInstanceOnFailure - The terminate instance on failure configuration of the infrastructure
configuration.
infrastructureConfiguration_arn :: Lens' InfrastructureConfiguration (Maybe Text) Source #
The Amazon Resource Name (ARN) of the infrastructure configuration.
infrastructureConfiguration_dateCreated :: Lens' InfrastructureConfiguration (Maybe Text) Source #
The date on which the infrastructure configuration was created.
infrastructureConfiguration_dateUpdated :: Lens' InfrastructureConfiguration (Maybe Text) Source #
The date on which the infrastructure configuration was last updated.
infrastructureConfiguration_description :: Lens' InfrastructureConfiguration (Maybe Text) Source #
The description of the infrastructure configuration.
infrastructureConfiguration_instanceMetadataOptions :: Lens' InfrastructureConfiguration (Maybe InstanceMetadataOptions) Source #
The instance metadata option settings for the infrastructure configuration.
infrastructureConfiguration_instanceProfileName :: Lens' InfrastructureConfiguration (Maybe Text) Source #
The instance profile of the infrastructure configuration.
infrastructureConfiguration_instanceTypes :: Lens' InfrastructureConfiguration (Maybe [Text]) Source #
The instance types of the infrastructure configuration.
infrastructureConfiguration_keyPair :: Lens' InfrastructureConfiguration (Maybe Text) Source #
The Amazon EC2 key pair of the infrastructure configuration.
infrastructureConfiguration_logging :: Lens' InfrastructureConfiguration (Maybe Logging) Source #
The logging configuration of the infrastructure configuration.
infrastructureConfiguration_name :: Lens' InfrastructureConfiguration (Maybe Text) Source #
The name of the infrastructure configuration.
infrastructureConfiguration_resourceTags :: Lens' InfrastructureConfiguration (Maybe (HashMap Text Text)) Source #
The tags attached to the resource created by Image Builder.
infrastructureConfiguration_securityGroupIds :: Lens' InfrastructureConfiguration (Maybe [Text]) Source #
The security group IDs of the infrastructure configuration.
infrastructureConfiguration_snsTopicArn :: Lens' InfrastructureConfiguration (Maybe Text) Source #
The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.
EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys from other accounts. The key that is used to encrypt the SNS topic must reside in the account that the Image Builder service runs under.
infrastructureConfiguration_subnetId :: Lens' InfrastructureConfiguration (Maybe Text) Source #
The subnet ID of the infrastructure configuration.
infrastructureConfiguration_tags :: Lens' InfrastructureConfiguration (Maybe (HashMap Text Text)) Source #
The tags of the infrastructure configuration.
infrastructureConfiguration_terminateInstanceOnFailure :: Lens' InfrastructureConfiguration (Maybe Bool) Source #
The terminate instance on failure configuration of the infrastructure configuration.
InfrastructureConfigurationSummary
data InfrastructureConfigurationSummary Source #
The infrastructure used when building Amazon EC2 AMIs.
See: newInfrastructureConfigurationSummary smart constructor.
Constructors
| InfrastructureConfigurationSummary' | |
Fields
| |
Instances
newInfrastructureConfigurationSummary :: InfrastructureConfigurationSummary Source #
Create a value of InfrastructureConfigurationSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:InfrastructureConfigurationSummary', infrastructureConfigurationSummary_arn - The Amazon Resource Name (ARN) of the infrastructure configuration.
$sel:dateCreated:InfrastructureConfigurationSummary', infrastructureConfigurationSummary_dateCreated - The date on which the infrastructure configuration was created.
$sel:dateUpdated:InfrastructureConfigurationSummary', infrastructureConfigurationSummary_dateUpdated - The date on which the infrastructure configuration was last updated.
$sel:description:InfrastructureConfigurationSummary', infrastructureConfigurationSummary_description - The description of the infrastructure configuration.
$sel:instanceProfileName:InfrastructureConfigurationSummary', infrastructureConfigurationSummary_instanceProfileName - The instance profile of the infrastructure configuration.
$sel:instanceTypes:InfrastructureConfigurationSummary', infrastructureConfigurationSummary_instanceTypes - The instance types of the infrastructure configuration.
$sel:name:InfrastructureConfigurationSummary', infrastructureConfigurationSummary_name - The name of the infrastructure configuration.
$sel:resourceTags:InfrastructureConfigurationSummary', infrastructureConfigurationSummary_resourceTags - The tags attached to the image created by Image Builder.
$sel:tags:InfrastructureConfigurationSummary', infrastructureConfigurationSummary_tags - The tags of the infrastructure configuration.
infrastructureConfigurationSummary_arn :: Lens' InfrastructureConfigurationSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the infrastructure configuration.
infrastructureConfigurationSummary_dateCreated :: Lens' InfrastructureConfigurationSummary (Maybe Text) Source #
The date on which the infrastructure configuration was created.
infrastructureConfigurationSummary_dateUpdated :: Lens' InfrastructureConfigurationSummary (Maybe Text) Source #
The date on which the infrastructure configuration was last updated.
infrastructureConfigurationSummary_description :: Lens' InfrastructureConfigurationSummary (Maybe Text) Source #
The description of the infrastructure configuration.
infrastructureConfigurationSummary_instanceProfileName :: Lens' InfrastructureConfigurationSummary (Maybe Text) Source #
The instance profile of the infrastructure configuration.
infrastructureConfigurationSummary_instanceTypes :: Lens' InfrastructureConfigurationSummary (Maybe [Text]) Source #
The instance types of the infrastructure configuration.
infrastructureConfigurationSummary_name :: Lens' InfrastructureConfigurationSummary (Maybe Text) Source #
The name of the infrastructure configuration.
infrastructureConfigurationSummary_resourceTags :: Lens' InfrastructureConfigurationSummary (Maybe (HashMap Text Text)) Source #
The tags attached to the image created by Image Builder.
infrastructureConfigurationSummary_tags :: Lens' InfrastructureConfigurationSummary (Maybe (HashMap Text Text)) Source #
The tags of the infrastructure configuration.
InstanceBlockDeviceMapping
data InstanceBlockDeviceMapping Source #
Defines block device mappings for the instance used to configure your image.
See: newInstanceBlockDeviceMapping smart constructor.
Constructors
| InstanceBlockDeviceMapping' | |
Fields
| |
Instances
newInstanceBlockDeviceMapping :: InstanceBlockDeviceMapping Source #
Create a value of InstanceBlockDeviceMapping with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deviceName:InstanceBlockDeviceMapping', instanceBlockDeviceMapping_deviceName - The device to which these mappings apply.
$sel:ebs:InstanceBlockDeviceMapping', instanceBlockDeviceMapping_ebs - Use to manage Amazon EBS-specific configuration for this mapping.
$sel:noDevice:InstanceBlockDeviceMapping', instanceBlockDeviceMapping_noDevice - Use to remove a mapping from the base image.
$sel:virtualName:InstanceBlockDeviceMapping', instanceBlockDeviceMapping_virtualName - Use to manage instance ephemeral devices.
instanceBlockDeviceMapping_deviceName :: Lens' InstanceBlockDeviceMapping (Maybe Text) Source #
The device to which these mappings apply.
instanceBlockDeviceMapping_ebs :: Lens' InstanceBlockDeviceMapping (Maybe EbsInstanceBlockDeviceSpecification) Source #
Use to manage Amazon EBS-specific configuration for this mapping.
instanceBlockDeviceMapping_noDevice :: Lens' InstanceBlockDeviceMapping (Maybe Text) Source #
Use to remove a mapping from the base image.
instanceBlockDeviceMapping_virtualName :: Lens' InstanceBlockDeviceMapping (Maybe Text) Source #
Use to manage instance ephemeral devices.
InstanceConfiguration
data InstanceConfiguration Source #
Defines a custom base AMI and block device mapping configurations of an instance used for building and testing container images.
See: newInstanceConfiguration smart constructor.
Constructors
| InstanceConfiguration' | |
Fields
| |
Instances
newInstanceConfiguration :: InstanceConfiguration Source #
Create a value of InstanceConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:blockDeviceMappings:InstanceConfiguration', instanceConfiguration_blockDeviceMappings - Defines the block devices to attach for building an instance from this
Image Builder AMI.
$sel:image:InstanceConfiguration', instanceConfiguration_image - The AMI ID to use as the base image for a container build and test
instance. If not specified, Image Builder will use the appropriate
ECS-optimized AMI as a base image.
instanceConfiguration_blockDeviceMappings :: Lens' InstanceConfiguration (Maybe [InstanceBlockDeviceMapping]) Source #
Defines the block devices to attach for building an instance from this Image Builder AMI.
instanceConfiguration_image :: Lens' InstanceConfiguration (Maybe Text) Source #
The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.
InstanceMetadataOptions
data InstanceMetadataOptions Source #
The instance metadata options that apply to the HTTP requests that pipeline builds use to launch EC2 build and test instances. For more information about instance metadata options, see Configure the instance metadata options in the /Amazon EC2 User Guide/ for Linux instances, or Configure the instance metadata options in the /Amazon EC2 Windows Guide/ for Windows instances.
See: newInstanceMetadataOptions smart constructor.
Constructors
| InstanceMetadataOptions' | |
Fields
| |
Instances
newInstanceMetadataOptions :: InstanceMetadataOptions Source #
Create a value of InstanceMetadataOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpPutResponseHopLimit:InstanceMetadataOptions', instanceMetadataOptions_httpPutResponseHopLimit - Limit the number of hops that an instance metadata request can traverse
to reach its destination.
$sel:httpTokens:InstanceMetadataOptions', instanceMetadataOptions_httpTokens - Indicates whether a signed token header is required for instance
metadata retrieval requests. The values affect the response as follows:
- required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.
- optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.
The default setting is optional.
instanceMetadataOptions_httpPutResponseHopLimit :: Lens' InstanceMetadataOptions (Maybe Natural) Source #
Limit the number of hops that an instance metadata request can traverse to reach its destination.
instanceMetadataOptions_httpTokens :: Lens' InstanceMetadataOptions (Maybe Text) Source #
Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:
- required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.
- optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.
The default setting is optional.
LaunchPermissionConfiguration
data LaunchPermissionConfiguration Source #
Describes the configuration for a launch permission. The launch
permission modification request is sent to the
Amazon EC2 ModifyImageAttribute
API on behalf of the user for each Region they have selected to
distribute the AMI. To make an AMI public, set the launch permission
authorized accounts to all. See the examples for making an AMI public
at
Amazon EC2 ModifyImageAttribute.
See: newLaunchPermissionConfiguration smart constructor.
Constructors
| LaunchPermissionConfiguration' | |
Fields
| |
Instances
newLaunchPermissionConfiguration :: LaunchPermissionConfiguration Source #
Create a value of LaunchPermissionConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:organizationArns:LaunchPermissionConfiguration', launchPermissionConfiguration_organizationArns - The ARN for an Amazon Web Services Organization that you want to share
your AMI with. For more information, see
What is Organizations?.
$sel:organizationalUnitArns:LaunchPermissionConfiguration', launchPermissionConfiguration_organizationalUnitArns - The ARN for an Organizations organizational unit (OU) that you want to
share your AMI with. For more information about key concepts for
Organizations, see
Organizations terminology and concepts.
$sel:userGroups:LaunchPermissionConfiguration', launchPermissionConfiguration_userGroups - The name of the group.
$sel:userIds:LaunchPermissionConfiguration', launchPermissionConfiguration_userIds - The Amazon Web Services account ID.
launchPermissionConfiguration_organizationArns :: Lens' LaunchPermissionConfiguration (Maybe (NonEmpty Text)) Source #
The ARN for an Amazon Web Services Organization that you want to share your AMI with. For more information, see What is Organizations?.
launchPermissionConfiguration_organizationalUnitArns :: Lens' LaunchPermissionConfiguration (Maybe (NonEmpty Text)) Source #
The ARN for an Organizations organizational unit (OU) that you want to share your AMI with. For more information about key concepts for Organizations, see Organizations terminology and concepts.
launchPermissionConfiguration_userGroups :: Lens' LaunchPermissionConfiguration (Maybe [Text]) Source #
The name of the group.
launchPermissionConfiguration_userIds :: Lens' LaunchPermissionConfiguration (Maybe (NonEmpty Text)) Source #
The Amazon Web Services account ID.
LaunchTemplateConfiguration
data LaunchTemplateConfiguration Source #
Identifies an Amazon EC2 launch template to use for a specific account.
See: newLaunchTemplateConfiguration smart constructor.
Constructors
| LaunchTemplateConfiguration' | |
Fields
| |
Instances
newLaunchTemplateConfiguration Source #
Create a value of LaunchTemplateConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:LaunchTemplateConfiguration', launchTemplateConfiguration_accountId - The account ID that this configuration applies to.
$sel:setDefaultVersion:LaunchTemplateConfiguration', launchTemplateConfiguration_setDefaultVersion - Set the specified Amazon EC2 launch template as the default launch
template for the specified account.
$sel:launchTemplateId:LaunchTemplateConfiguration', launchTemplateConfiguration_launchTemplateId - Identifies the Amazon EC2 launch template to use.
launchTemplateConfiguration_accountId :: Lens' LaunchTemplateConfiguration (Maybe Text) Source #
The account ID that this configuration applies to.
launchTemplateConfiguration_setDefaultVersion :: Lens' LaunchTemplateConfiguration (Maybe Bool) Source #
Set the specified Amazon EC2 launch template as the default launch template for the specified account.
launchTemplateConfiguration_launchTemplateId :: Lens' LaunchTemplateConfiguration Text Source #
Identifies the Amazon EC2 launch template to use.
Logging
Logging configuration defines where Image Builder uploads your logs.
See: newLogging smart constructor.
Instances
| FromJSON Logging Source # | |
| ToJSON Logging Source # | |
Defined in Amazonka.ImageBuilder.Types.Logging | |
| Generic Logging Source # | |
| Read Logging Source # | |
| Show Logging Source # | |
| NFData Logging Source # | |
Defined in Amazonka.ImageBuilder.Types.Logging | |
| Eq Logging Source # | |
| Hashable Logging Source # | |
Defined in Amazonka.ImageBuilder.Types.Logging | |
| type Rep Logging Source # | |
Defined in Amazonka.ImageBuilder.Types.Logging | |
newLogging :: Logging Source #
Create a value of Logging with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3Logs:Logging', logging_s3Logs - The Amazon S3 logging configuration.
OutputResources
data OutputResources Source #
The resources produced by this image.
See: newOutputResources smart constructor.
Constructors
| OutputResources' | |
Instances
newOutputResources :: OutputResources Source #
Create a value of OutputResources with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:amis:OutputResources', outputResources_amis - The Amazon EC2 AMIs created by this image.
$sel:containers:OutputResources', outputResources_containers - Container images that the pipeline has generated and stored in the
output repository.
outputResources_amis :: Lens' OutputResources (Maybe [Ami]) Source #
The Amazon EC2 AMIs created by this image.
outputResources_containers :: Lens' OutputResources (Maybe [Container]) Source #
Container images that the pipeline has generated and stored in the output repository.
S3ExportConfiguration
data S3ExportConfiguration Source #
Properties that configure export from your build instance to a compatible file format for your VM.
See: newS3ExportConfiguration smart constructor.
Constructors
| S3ExportConfiguration' | |
Fields
| |
Instances
newS3ExportConfiguration Source #
Arguments
| :: Text | |
| -> DiskImageFormat | |
| -> Text | |
| -> S3ExportConfiguration |
Create a value of S3ExportConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3Prefix:S3ExportConfiguration', s3ExportConfiguration_s3Prefix - The Amazon S3 path for the bucket where the output disk images for your
VM are stored.
$sel:roleName:S3ExportConfiguration', s3ExportConfiguration_roleName - The name of the role that grants VM Import/Export permission to export
images to your S3 bucket.
$sel:diskImageFormat:S3ExportConfiguration', s3ExportConfiguration_diskImageFormat - 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.
$sel:s3Bucket:S3ExportConfiguration', s3ExportConfiguration_s3Bucket - The S3 bucket in which to store the output disk images for your VM.
s3ExportConfiguration_s3Prefix :: Lens' S3ExportConfiguration (Maybe Text) Source #
The Amazon S3 path for the bucket where the output disk images for your VM are stored.
s3ExportConfiguration_roleName :: Lens' S3ExportConfiguration Text Source #
The name of the role that grants VM Import/Export permission to export images to your S3 bucket.
s3ExportConfiguration_diskImageFormat :: Lens' S3ExportConfiguration DiskImageFormat Source #
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.
s3ExportConfiguration_s3Bucket :: Lens' S3ExportConfiguration Text Source #
The S3 bucket in which to store the output disk images for your VM.
S3Logs
Amazon S3 logging configuration.
See: newS3Logs smart constructor.
Constructors
| S3Logs' | |
Fields
| |
Instances
| FromJSON S3Logs Source # | |
| ToJSON S3Logs Source # | |
Defined in Amazonka.ImageBuilder.Types.S3Logs | |
| Generic S3Logs Source # | |
| Read S3Logs Source # | |
| Show S3Logs Source # | |
| NFData S3Logs Source # | |
Defined in Amazonka.ImageBuilder.Types.S3Logs | |
| Eq S3Logs Source # | |
| Hashable S3Logs Source # | |
Defined in Amazonka.ImageBuilder.Types.S3Logs | |
| type Rep S3Logs Source # | |
Defined in Amazonka.ImageBuilder.Types.S3Logs type Rep S3Logs = D1 ('MetaData "S3Logs" "Amazonka.ImageBuilder.Types.S3Logs" "amazonka-imagebuilder-2.0-BBLLjX59RW72O8VbQ3vKvH" 'False) (C1 ('MetaCons "S3Logs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "s3BucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "s3KeyPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
Create a value of S3Logs with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3BucketName:S3Logs', s3Logs_s3BucketName - The S3 bucket in which to store the logs.
$sel:s3KeyPrefix:S3Logs', s3Logs_s3KeyPrefix - The Amazon S3 path to the bucket where the logs are stored.
s3Logs_s3KeyPrefix :: Lens' S3Logs (Maybe Text) Source #
The Amazon S3 path to the bucket where the logs are stored.
Schedule
A schedule configures how often and when a pipeline will automatically create a new image.
See: newSchedule smart constructor.
Constructors
| Schedule' | |
Fields
| |
Instances
newSchedule :: Schedule Source #
Create a value of Schedule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pipelineExecutionStartCondition:Schedule', schedule_pipelineExecutionStartCondition - The condition configures when the pipeline should trigger a new image
build. When the pipelineExecutionStartCondition is set to
EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use
semantic version filters on the base image or components in your image
recipe, EC2 Image Builder will build a new image only when there are new
versions of the image or components in your recipe that match the
semantic version filter. When it is set to EXPRESSION_MATCH_ONLY, it
will build a new image every time the CRON expression matches the
current time. For semantic version syntax, see
CreateComponent
in the EC2 Image Builder API Reference.
$sel:scheduleExpression:Schedule', schedule_scheduleExpression - The cron expression determines how often EC2 Image Builder evaluates
your pipelineExecutionStartCondition.
For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.
$sel:timezone:Schedule', schedule_timezone - The timezone that applies to the scheduling expression. For example,
"Etc/UTC", "America/Los_Angeles" in the
IANA timezone format. If
not specified this defaults to UTC.
schedule_pipelineExecutionStartCondition :: Lens' Schedule (Maybe PipelineExecutionStartCondition) Source #
The condition configures when the pipeline should trigger a new image
build. When the pipelineExecutionStartCondition is set to
EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use
semantic version filters on the base image or components in your image
recipe, EC2 Image Builder will build a new image only when there are new
versions of the image or components in your recipe that match the
semantic version filter. When it is set to EXPRESSION_MATCH_ONLY, it
will build a new image every time the CRON expression matches the
current time. For semantic version syntax, see
CreateComponent
in the EC2 Image Builder API Reference.
schedule_scheduleExpression :: Lens' Schedule (Maybe Text) Source #
The cron expression determines how often EC2 Image Builder evaluates
your pipelineExecutionStartCondition.
For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.
schedule_timezone :: Lens' Schedule (Maybe Text) Source #
The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.
SystemsManagerAgent
data SystemsManagerAgent Source #
Contains settings for the Systems Manager agent on your build instance.
See: newSystemsManagerAgent smart constructor.
Constructors
| SystemsManagerAgent' | |
Fields
| |
Instances
newSystemsManagerAgent :: SystemsManagerAgent Source #
Create a value of SystemsManagerAgent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:uninstallAfterBuild:SystemsManagerAgent', systemsManagerAgent_uninstallAfterBuild - Controls whether the Systems Manager agent is removed from your final
build image, prior to creating the new AMI. If this is set to true, then
the agent is removed from the final image. If it's set to false, then
the agent is left in, so that it is included in the new AMI. The default
value is false.
systemsManagerAgent_uninstallAfterBuild :: Lens' SystemsManagerAgent (Maybe Bool) Source #
Controls whether the Systems Manager agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.
TargetContainerRepository
data TargetContainerRepository Source #
The container repository where the output container image is stored.
See: newTargetContainerRepository smart constructor.
Constructors
| TargetContainerRepository' | |
Fields
| |
Instances
newTargetContainerRepository Source #
Arguments
| :: ContainerRepositoryService | |
| -> Text | |
| -> TargetContainerRepository |
Create a value of TargetContainerRepository with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:service:TargetContainerRepository', targetContainerRepository_service - Specifies the service in which this image was registered.
$sel:repositoryName:TargetContainerRepository', targetContainerRepository_repositoryName - The name of the container repository where the output container image is
stored. This name is prefixed by the repository location.
targetContainerRepository_service :: Lens' TargetContainerRepository ContainerRepositoryService Source #
Specifies the service in which this image was registered.
targetContainerRepository_repositoryName :: Lens' TargetContainerRepository Text Source #
The name of the container repository where the output container image is stored. This name is prefixed by the repository location.