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 |
- Service Configuration
- Errors
- CallRateLimitExceededException
- ClientException
- ForbiddenException
- IdempotentParameterMismatchException
- InvalidPaginationTokenException
- InvalidParameterCombinationException
- InvalidParameterException
- InvalidParameterValueException
- InvalidRequestException
- InvalidVersionNumberException
- ResourceAlreadyExistsException
- ResourceDependencyException
- ResourceInUseException
- ResourceNotFoundException
- ServiceException
- ServiceQuotaExceededException
- ServiceUnavailableException
- Waiters
- Operations
- CancelImageCreation
- CreateComponent
- CreateContainerRecipe
- CreateDistributionConfiguration
- CreateImage
- CreateImagePipeline
- CreateImageRecipe
- CreateInfrastructureConfiguration
- DeleteComponent
- DeleteContainerRecipe
- DeleteDistributionConfiguration
- DeleteImage
- DeleteImagePipeline
- DeleteImageRecipe
- DeleteInfrastructureConfiguration
- GetComponent
- GetComponentPolicy
- GetContainerRecipe
- GetContainerRecipePolicy
- GetDistributionConfiguration
- GetImage
- GetImagePipeline
- GetImagePolicy
- GetImageRecipe
- GetImageRecipePolicy
- GetInfrastructureConfiguration
- ImportComponent
- ImportVmImage
- ListComponentBuildVersions
- ListComponents
- ListContainerRecipes
- ListDistributionConfigurations
- ListImageBuildVersions
- ListImagePackages
- ListImagePipelineImages
- ListImagePipelines
- ListImageRecipes
- ListImages
- ListInfrastructureConfigurations
- ListTagsForResource
- PutComponentPolicy
- PutContainerRecipePolicy
- PutImagePolicy
- PutImageRecipePolicy
- StartImagePipelineExecution
- TagResource
- UntagResource
- UpdateDistributionConfiguration
- UpdateImagePipeline
- UpdateInfrastructureConfiguration
- Types
- 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
Derived from API version 2019-12-02
of the AWS service descriptions, licensed under Apache 2.0.
EC2 Image Builder is a fully managed Amazon Web Services service that makes it easier to automate the creation, management, and deployment of customized, secure, and up-to-date "golden" server images that are pre-installed and pre-configured with software and settings to meet specific IT standards.
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
- data CancelImageCreation = CancelImageCreation' Text Text
- newCancelImageCreation :: Text -> Text -> CancelImageCreation
- data CancelImageCreationResponse = CancelImageCreationResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCancelImageCreationResponse :: Int -> CancelImageCreationResponse
- data CreateComponent = CreateComponent' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (HashMap Text Text)) (Maybe Text) Text Text Platform Text
- newCreateComponent :: Text -> Text -> Platform -> Text -> CreateComponent
- data CreateComponentResponse = CreateComponentResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCreateComponentResponse :: Int -> CreateComponentResponse
- data CreateContainerRecipe = CreateContainerRecipe' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InstanceConfiguration) (Maybe Text) (Maybe Platform) (Maybe (HashMap Text Text)) (Maybe Text) ContainerType Text Text (NonEmpty ComponentConfiguration) Text TargetContainerRepository Text
- newCreateContainerRecipe :: ContainerType -> Text -> Text -> NonEmpty ComponentConfiguration -> Text -> TargetContainerRepository -> Text -> CreateContainerRecipe
- data CreateContainerRecipeResponse = CreateContainerRecipeResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCreateContainerRecipeResponse :: Int -> CreateContainerRecipeResponse
- data CreateDistributionConfiguration = CreateDistributionConfiguration' (Maybe Text) (Maybe (HashMap Text Text)) Text [Distribution] Text
- newCreateDistributionConfiguration :: Text -> Text -> CreateDistributionConfiguration
- data CreateDistributionConfigurationResponse = CreateDistributionConfigurationResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCreateDistributionConfigurationResponse :: Int -> CreateDistributionConfigurationResponse
- data CreateImage = CreateImage' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe ImageTestsConfiguration) (Maybe (HashMap Text Text)) Text Text
- newCreateImage :: Text -> Text -> CreateImage
- data CreateImageResponse = CreateImageResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCreateImageResponse :: Int -> CreateImageResponse
- data CreateImagePipeline = CreateImagePipeline' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe ImageTestsConfiguration) (Maybe Schedule) (Maybe PipelineStatus) (Maybe (HashMap Text Text)) Text Text Text
- newCreateImagePipeline :: Text -> Text -> Text -> CreateImagePipeline
- data CreateImagePipelineResponse = CreateImagePipelineResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCreateImagePipelineResponse :: Int -> CreateImagePipelineResponse
- data CreateImageRecipe = CreateImageRecipe' (Maybe AdditionalInstanceConfiguration) (Maybe [InstanceBlockDeviceMapping]) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) Text Text (NonEmpty ComponentConfiguration) Text Text
- newCreateImageRecipe :: Text -> Text -> NonEmpty ComponentConfiguration -> Text -> Text -> CreateImageRecipe
- data CreateImageRecipeResponse = CreateImageRecipeResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCreateImageRecipeResponse :: Int -> CreateImageRecipeResponse
- data CreateInfrastructureConfiguration = CreateInfrastructureConfiguration' (Maybe Text) (Maybe InstanceMetadataOptions) (Maybe [Text]) (Maybe Text) (Maybe Logging) (Maybe (HashMap Text Text)) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Bool) Text Text Text
- newCreateInfrastructureConfiguration :: Text -> Text -> Text -> CreateInfrastructureConfiguration
- data CreateInfrastructureConfigurationResponse = CreateInfrastructureConfigurationResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCreateInfrastructureConfigurationResponse :: Int -> CreateInfrastructureConfigurationResponse
- data DeleteComponent = DeleteComponent' Text
- newDeleteComponent :: Text -> DeleteComponent
- data DeleteComponentResponse = DeleteComponentResponse' (Maybe Text) (Maybe Text) Int
- newDeleteComponentResponse :: Int -> DeleteComponentResponse
- data DeleteContainerRecipe = DeleteContainerRecipe' Text
- newDeleteContainerRecipe :: Text -> DeleteContainerRecipe
- data DeleteContainerRecipeResponse = DeleteContainerRecipeResponse' (Maybe Text) (Maybe Text) Int
- newDeleteContainerRecipeResponse :: Int -> DeleteContainerRecipeResponse
- data DeleteDistributionConfiguration = DeleteDistributionConfiguration' Text
- newDeleteDistributionConfiguration :: Text -> DeleteDistributionConfiguration
- data DeleteDistributionConfigurationResponse = DeleteDistributionConfigurationResponse' (Maybe Text) (Maybe Text) Int
- newDeleteDistributionConfigurationResponse :: Int -> DeleteDistributionConfigurationResponse
- data DeleteImage = DeleteImage' Text
- newDeleteImage :: Text -> DeleteImage
- data DeleteImageResponse = DeleteImageResponse' (Maybe Text) (Maybe Text) Int
- newDeleteImageResponse :: Int -> DeleteImageResponse
- data DeleteImagePipeline = DeleteImagePipeline' Text
- newDeleteImagePipeline :: Text -> DeleteImagePipeline
- data DeleteImagePipelineResponse = DeleteImagePipelineResponse' (Maybe Text) (Maybe Text) Int
- newDeleteImagePipelineResponse :: Int -> DeleteImagePipelineResponse
- data DeleteImageRecipe = DeleteImageRecipe' Text
- newDeleteImageRecipe :: Text -> DeleteImageRecipe
- data DeleteImageRecipeResponse = DeleteImageRecipeResponse' (Maybe Text) (Maybe Text) Int
- newDeleteImageRecipeResponse :: Int -> DeleteImageRecipeResponse
- data DeleteInfrastructureConfiguration = DeleteInfrastructureConfiguration' Text
- newDeleteInfrastructureConfiguration :: Text -> DeleteInfrastructureConfiguration
- data DeleteInfrastructureConfigurationResponse = DeleteInfrastructureConfigurationResponse' (Maybe Text) (Maybe Text) Int
- newDeleteInfrastructureConfigurationResponse :: Int -> DeleteInfrastructureConfigurationResponse
- data GetComponent = GetComponent' Text
- newGetComponent :: Text -> GetComponent
- data GetComponentResponse = GetComponentResponse' (Maybe Component) (Maybe Text) Int
- newGetComponentResponse :: Int -> GetComponentResponse
- data GetComponentPolicy = GetComponentPolicy' Text
- newGetComponentPolicy :: Text -> GetComponentPolicy
- data GetComponentPolicyResponse = GetComponentPolicyResponse' (Maybe Text) (Maybe Text) Int
- newGetComponentPolicyResponse :: Int -> GetComponentPolicyResponse
- data GetContainerRecipe = GetContainerRecipe' Text
- newGetContainerRecipe :: Text -> GetContainerRecipe
- data GetContainerRecipeResponse = GetContainerRecipeResponse' (Maybe ContainerRecipe) (Maybe Text) Int
- newGetContainerRecipeResponse :: Int -> GetContainerRecipeResponse
- data GetContainerRecipePolicy = GetContainerRecipePolicy' Text
- newGetContainerRecipePolicy :: Text -> GetContainerRecipePolicy
- data GetContainerRecipePolicyResponse = GetContainerRecipePolicyResponse' (Maybe Text) (Maybe Text) Int
- newGetContainerRecipePolicyResponse :: Int -> GetContainerRecipePolicyResponse
- data GetDistributionConfiguration = GetDistributionConfiguration' Text
- newGetDistributionConfiguration :: Text -> GetDistributionConfiguration
- data GetDistributionConfigurationResponse = GetDistributionConfigurationResponse' (Maybe DistributionConfiguration) (Maybe Text) Int
- newGetDistributionConfigurationResponse :: Int -> GetDistributionConfigurationResponse
- data GetImage = GetImage' Text
- newGetImage :: Text -> GetImage
- data GetImageResponse = GetImageResponse' (Maybe Image) (Maybe Text) Int
- newGetImageResponse :: Int -> GetImageResponse
- data GetImagePipeline = GetImagePipeline' Text
- newGetImagePipeline :: Text -> GetImagePipeline
- data GetImagePipelineResponse = GetImagePipelineResponse' (Maybe ImagePipeline) (Maybe Text) Int
- newGetImagePipelineResponse :: Int -> GetImagePipelineResponse
- data GetImagePolicy = GetImagePolicy' Text
- newGetImagePolicy :: Text -> GetImagePolicy
- data GetImagePolicyResponse = GetImagePolicyResponse' (Maybe Text) (Maybe Text) Int
- newGetImagePolicyResponse :: Int -> GetImagePolicyResponse
- data GetImageRecipe = GetImageRecipe' Text
- newGetImageRecipe :: Text -> GetImageRecipe
- data GetImageRecipeResponse = GetImageRecipeResponse' (Maybe ImageRecipe) (Maybe Text) Int
- newGetImageRecipeResponse :: Int -> GetImageRecipeResponse
- data GetImageRecipePolicy = GetImageRecipePolicy' Text
- newGetImageRecipePolicy :: Text -> GetImageRecipePolicy
- data GetImageRecipePolicyResponse = GetImageRecipePolicyResponse' (Maybe Text) (Maybe Text) Int
- newGetImageRecipePolicyResponse :: Int -> GetImageRecipePolicyResponse
- data GetInfrastructureConfiguration = GetInfrastructureConfiguration' Text
- newGetInfrastructureConfiguration :: Text -> GetInfrastructureConfiguration
- data GetInfrastructureConfigurationResponse = GetInfrastructureConfigurationResponse' (Maybe InfrastructureConfiguration) (Maybe Text) Int
- newGetInfrastructureConfigurationResponse :: Int -> GetInfrastructureConfigurationResponse
- data ImportComponent = ImportComponent' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) Text Text ComponentType ComponentFormat Platform Text
- newImportComponent :: Text -> Text -> ComponentType -> ComponentFormat -> Platform -> Text -> ImportComponent
- data ImportComponentResponse = ImportComponentResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newImportComponentResponse :: Int -> ImportComponentResponse
- data ImportVmImage = ImportVmImage' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Text Text Platform Text Text
- newImportVmImage :: Text -> Text -> Platform -> Text -> Text -> ImportVmImage
- data ImportVmImageResponse = ImportVmImageResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newImportVmImageResponse :: Int -> ImportVmImageResponse
- data ListComponentBuildVersions = ListComponentBuildVersions' (Maybe Natural) (Maybe Text) Text
- newListComponentBuildVersions :: Text -> ListComponentBuildVersions
- data ListComponentBuildVersionsResponse = ListComponentBuildVersionsResponse' (Maybe [ComponentSummary]) (Maybe Text) (Maybe Text) Int
- newListComponentBuildVersionsResponse :: Int -> ListComponentBuildVersionsResponse
- data ListComponents = ListComponents' (Maybe Bool) (Maybe (NonEmpty Filter)) (Maybe Natural) (Maybe Text) (Maybe Ownership)
- newListComponents :: ListComponents
- data ListComponentsResponse = ListComponentsResponse' (Maybe [ComponentVersion]) (Maybe Text) (Maybe Text) Int
- newListComponentsResponse :: Int -> ListComponentsResponse
- data ListContainerRecipes = ListContainerRecipes' (Maybe (NonEmpty Filter)) (Maybe Natural) (Maybe Text) (Maybe Ownership)
- newListContainerRecipes :: ListContainerRecipes
- data ListContainerRecipesResponse = ListContainerRecipesResponse' (Maybe [ContainerRecipeSummary]) (Maybe Text) (Maybe Text) Int
- newListContainerRecipesResponse :: Int -> ListContainerRecipesResponse
- data ListDistributionConfigurations = ListDistributionConfigurations' (Maybe (NonEmpty Filter)) (Maybe Natural) (Maybe Text)
- newListDistributionConfigurations :: ListDistributionConfigurations
- data ListDistributionConfigurationsResponse = ListDistributionConfigurationsResponse' (Maybe [DistributionConfigurationSummary]) (Maybe Text) (Maybe Text) Int
- newListDistributionConfigurationsResponse :: Int -> ListDistributionConfigurationsResponse
- data ListImageBuildVersions = ListImageBuildVersions' (Maybe (NonEmpty Filter)) (Maybe Natural) (Maybe Text) Text
- newListImageBuildVersions :: Text -> ListImageBuildVersions
- data ListImageBuildVersionsResponse = ListImageBuildVersionsResponse' (Maybe [ImageSummary]) (Maybe Text) (Maybe Text) Int
- newListImageBuildVersionsResponse :: Int -> ListImageBuildVersionsResponse
- data ListImagePackages = ListImagePackages' (Maybe Natural) (Maybe Text) Text
- newListImagePackages :: Text -> ListImagePackages
- data ListImagePackagesResponse = ListImagePackagesResponse' (Maybe [ImagePackage]) (Maybe Text) (Maybe Text) Int
- newListImagePackagesResponse :: Int -> ListImagePackagesResponse
- data ListImagePipelineImages = ListImagePipelineImages' (Maybe (NonEmpty Filter)) (Maybe Natural) (Maybe Text) Text
- newListImagePipelineImages :: Text -> ListImagePipelineImages
- data ListImagePipelineImagesResponse = ListImagePipelineImagesResponse' (Maybe [ImageSummary]) (Maybe Text) (Maybe Text) Int
- newListImagePipelineImagesResponse :: Int -> ListImagePipelineImagesResponse
- data ListImagePipelines = ListImagePipelines' (Maybe (NonEmpty Filter)) (Maybe Natural) (Maybe Text)
- newListImagePipelines :: ListImagePipelines
- data ListImagePipelinesResponse = ListImagePipelinesResponse' (Maybe [ImagePipeline]) (Maybe Text) (Maybe Text) Int
- newListImagePipelinesResponse :: Int -> ListImagePipelinesResponse
- data ListImageRecipes = ListImageRecipes' (Maybe (NonEmpty Filter)) (Maybe Natural) (Maybe Text) (Maybe Ownership)
- newListImageRecipes :: ListImageRecipes
- data ListImageRecipesResponse = ListImageRecipesResponse' (Maybe [ImageRecipeSummary]) (Maybe Text) (Maybe Text) Int
- newListImageRecipesResponse :: Int -> ListImageRecipesResponse
- data ListImages = ListImages' (Maybe Bool) (Maybe (NonEmpty Filter)) (Maybe Bool) (Maybe Natural) (Maybe Text) (Maybe Ownership)
- newListImages :: ListImages
- data ListImagesResponse = ListImagesResponse' (Maybe [ImageVersion]) (Maybe Text) (Maybe Text) Int
- newListImagesResponse :: Int -> ListImagesResponse
- data ListInfrastructureConfigurations = ListInfrastructureConfigurations' (Maybe (NonEmpty Filter)) (Maybe Natural) (Maybe Text)
- newListInfrastructureConfigurations :: ListInfrastructureConfigurations
- data ListInfrastructureConfigurationsResponse = ListInfrastructureConfigurationsResponse' (Maybe [InfrastructureConfigurationSummary]) (Maybe Text) (Maybe Text) Int
- newListInfrastructureConfigurationsResponse :: Int -> ListInfrastructureConfigurationsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data PutComponentPolicy = PutComponentPolicy' Text Text
- newPutComponentPolicy :: Text -> Text -> PutComponentPolicy
- data PutComponentPolicyResponse = PutComponentPolicyResponse' (Maybe Text) (Maybe Text) Int
- newPutComponentPolicyResponse :: Int -> PutComponentPolicyResponse
- data PutContainerRecipePolicy = PutContainerRecipePolicy' Text Text
- newPutContainerRecipePolicy :: Text -> Text -> PutContainerRecipePolicy
- data PutContainerRecipePolicyResponse = PutContainerRecipePolicyResponse' (Maybe Text) (Maybe Text) Int
- newPutContainerRecipePolicyResponse :: Int -> PutContainerRecipePolicyResponse
- data PutImagePolicy = PutImagePolicy' Text Text
- newPutImagePolicy :: Text -> Text -> PutImagePolicy
- data PutImagePolicyResponse = PutImagePolicyResponse' (Maybe Text) (Maybe Text) Int
- newPutImagePolicyResponse :: Int -> PutImagePolicyResponse
- data PutImageRecipePolicy = PutImageRecipePolicy' Text Text
- newPutImageRecipePolicy :: Text -> Text -> PutImageRecipePolicy
- data PutImageRecipePolicyResponse = PutImageRecipePolicyResponse' (Maybe Text) (Maybe Text) Int
- newPutImageRecipePolicyResponse :: Int -> PutImageRecipePolicyResponse
- data StartImagePipelineExecution = StartImagePipelineExecution' Text Text
- newStartImagePipelineExecution :: Text -> Text -> StartImagePipelineExecution
- data StartImagePipelineExecutionResponse = StartImagePipelineExecutionResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newStartImagePipelineExecutionResponse :: Int -> StartImagePipelineExecutionResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateDistributionConfiguration = UpdateDistributionConfiguration' (Maybe Text) Text [Distribution] Text
- newUpdateDistributionConfiguration :: Text -> Text -> UpdateDistributionConfiguration
- data UpdateDistributionConfigurationResponse = UpdateDistributionConfigurationResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newUpdateDistributionConfigurationResponse :: Int -> UpdateDistributionConfigurationResponse
- data UpdateImagePipeline = UpdateImagePipeline' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe ImageTestsConfiguration) (Maybe Schedule) (Maybe PipelineStatus) Text Text Text
- newUpdateImagePipeline :: Text -> Text -> Text -> UpdateImagePipeline
- data UpdateImagePipelineResponse = UpdateImagePipelineResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newUpdateImagePipelineResponse :: Int -> UpdateImagePipelineResponse
- data UpdateInfrastructureConfiguration = UpdateInfrastructureConfiguration' (Maybe Text) (Maybe InstanceMetadataOptions) (Maybe [Text]) (Maybe Text) (Maybe Logging) (Maybe (HashMap Text Text)) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Bool) Text Text Text
- newUpdateInfrastructureConfiguration :: Text -> Text -> Text -> UpdateInfrastructureConfiguration
- data UpdateInfrastructureConfigurationResponse = UpdateInfrastructureConfigurationResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newUpdateInfrastructureConfigurationResponse :: Int -> UpdateInfrastructureConfigurationResponse
- 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' (Maybe SystemsManagerAgent) (Maybe Text)
- newAdditionalInstanceConfiguration :: AdditionalInstanceConfiguration
- data Ami = Ami' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ImageState)
- newAmi :: Ami
- data AmiDistributionConfiguration = AmiDistributionConfiguration' (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe LaunchPermissionConfiguration) (Maybe Text) (Maybe (NonEmpty Text))
- newAmiDistributionConfiguration :: AmiDistributionConfiguration
- data Component = Component' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [ComponentParameterDetail]) (Maybe Platform) (Maybe ComponentState) (Maybe (NonEmpty Text)) (Maybe (HashMap Text Text)) (Maybe ComponentType) (Maybe Text)
- newComponent :: Component
- data ComponentConfiguration = ComponentConfiguration' (Maybe (NonEmpty ComponentParameter)) Text
- newComponentConfiguration :: Text -> ComponentConfiguration
- data ComponentParameter = ComponentParameter' Text [Text]
- newComponentParameter :: Text -> ComponentParameter
- data ComponentParameterDetail = ComponentParameterDetail' (Maybe [Text]) (Maybe Text) Text Text
- newComponentParameterDetail :: Text -> Text -> ComponentParameterDetail
- data ComponentState = ComponentState' (Maybe Text) (Maybe ComponentStatus)
- newComponentState :: ComponentState
- data ComponentSummary = ComponentSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Platform) (Maybe ComponentState) (Maybe (NonEmpty Text)) (Maybe (HashMap Text Text)) (Maybe ComponentType) (Maybe Text)
- newComponentSummary :: ComponentSummary
- data ComponentVersion = ComponentVersion' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Platform) (Maybe (NonEmpty Text)) (Maybe ComponentType) (Maybe Text)
- newComponentVersion :: ComponentVersion
- data Container = Container' (Maybe [Text]) (Maybe Text)
- newContainer :: Container
- data ContainerDistributionConfiguration = ContainerDistributionConfiguration' (Maybe [Text]) (Maybe Text) TargetContainerRepository
- newContainerDistributionConfiguration :: TargetContainerRepository -> ContainerDistributionConfiguration
- data ContainerRecipe = ContainerRecipe' (Maybe Text) (Maybe (NonEmpty ComponentConfiguration)) (Maybe ContainerType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe InstanceConfiguration) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Platform) (Maybe (HashMap Text Text)) (Maybe TargetContainerRepository) (Maybe Text) (Maybe Text)
- newContainerRecipe :: ContainerRecipe
- data ContainerRecipeSummary = ContainerRecipeSummary' (Maybe Text) (Maybe ContainerType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Platform) (Maybe (HashMap Text Text))
- newContainerRecipeSummary :: ContainerRecipeSummary
- data Distribution = Distribution' (Maybe AmiDistributionConfiguration) (Maybe ContainerDistributionConfiguration) (Maybe (NonEmpty FastLaunchConfiguration)) (Maybe (NonEmpty LaunchTemplateConfiguration)) (Maybe (NonEmpty Text)) (Maybe S3ExportConfiguration) Text
- newDistribution :: Text -> Distribution
- data DistributionConfiguration = DistributionConfiguration' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Distribution]) (Maybe Text) (Maybe (HashMap Text Text)) Natural
- newDistributionConfiguration :: Natural -> DistributionConfiguration
- data DistributionConfigurationSummary = DistributionConfigurationSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe (HashMap Text Text))
- newDistributionConfigurationSummary :: DistributionConfigurationSummary
- data EbsInstanceBlockDeviceSpecification = EbsInstanceBlockDeviceSpecification' (Maybe Bool) (Maybe Bool) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe EbsVolumeType)
- newEbsInstanceBlockDeviceSpecification :: EbsInstanceBlockDeviceSpecification
- data FastLaunchConfiguration = FastLaunchConfiguration' (Maybe Text) (Maybe FastLaunchLaunchTemplateSpecification) (Maybe Natural) (Maybe FastLaunchSnapshotConfiguration) Bool
- newFastLaunchConfiguration :: Bool -> FastLaunchConfiguration
- data FastLaunchLaunchTemplateSpecification = FastLaunchLaunchTemplateSpecification' (Maybe Text) (Maybe Text) (Maybe Text)
- newFastLaunchLaunchTemplateSpecification :: FastLaunchLaunchTemplateSpecification
- data FastLaunchSnapshotConfiguration = FastLaunchSnapshotConfiguration' (Maybe Natural)
- newFastLaunchSnapshotConfiguration :: FastLaunchSnapshotConfiguration
- data Filter = Filter' (Maybe Text) (Maybe (NonEmpty Text))
- newFilter :: Filter
- data Image = Image' (Maybe Text) (Maybe BuildType) (Maybe ContainerRecipe) (Maybe Text) (Maybe DistributionConfiguration) (Maybe Bool) (Maybe ImageRecipe) (Maybe ImageTestsConfiguration) (Maybe InfrastructureConfiguration) (Maybe Text) (Maybe Text) (Maybe OutputResources) (Maybe Platform) (Maybe Text) (Maybe Text) (Maybe ImageState) (Maybe (HashMap Text Text)) (Maybe ImageType) (Maybe Text)
- newImage :: Image
- data ImagePackage = ImagePackage' (Maybe Text) (Maybe Text)
- newImagePackage :: ImagePackage
- data ImagePipeline = ImagePipeline' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe ImageTestsConfiguration) (Maybe Text) (Maybe Text) (Maybe Platform) (Maybe Schedule) (Maybe PipelineStatus) (Maybe (HashMap Text Text))
- newImagePipeline :: ImagePipeline
- data ImageRecipe = ImageRecipe' (Maybe AdditionalInstanceConfiguration) (Maybe Text) (Maybe [InstanceBlockDeviceMapping]) (Maybe (NonEmpty ComponentConfiguration)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Platform) (Maybe (HashMap Text Text)) (Maybe ImageType) (Maybe Text) (Maybe Text)
- newImageRecipe :: ImageRecipe
- data ImageRecipeSummary = ImageRecipeSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Platform) (Maybe (HashMap Text Text))
- newImageRecipeSummary :: ImageRecipeSummary
- data ImageState = ImageState' (Maybe Text) (Maybe ImageStatus)
- newImageState :: ImageState
- data ImageSummary = ImageSummary' (Maybe Text) (Maybe BuildType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe OutputResources) (Maybe Text) (Maybe Platform) (Maybe ImageState) (Maybe (HashMap Text Text)) (Maybe ImageType) (Maybe Text)
- newImageSummary :: ImageSummary
- data ImageTestsConfiguration = ImageTestsConfiguration' (Maybe Bool) (Maybe Natural)
- newImageTestsConfiguration :: ImageTestsConfiguration
- data ImageVersion = ImageVersion' (Maybe Text) (Maybe BuildType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Platform) (Maybe ImageType) (Maybe Text)
- newImageVersion :: ImageVersion
- data InfrastructureConfiguration = InfrastructureConfiguration' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InstanceMetadataOptions) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Logging) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Bool)
- newInfrastructureConfiguration :: InfrastructureConfiguration
- data InfrastructureConfigurationSummary = InfrastructureConfigurationSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text))
- newInfrastructureConfigurationSummary :: InfrastructureConfigurationSummary
- data InstanceBlockDeviceMapping = InstanceBlockDeviceMapping' (Maybe Text) (Maybe EbsInstanceBlockDeviceSpecification) (Maybe Text) (Maybe Text)
- newInstanceBlockDeviceMapping :: InstanceBlockDeviceMapping
- data InstanceConfiguration = InstanceConfiguration' (Maybe [InstanceBlockDeviceMapping]) (Maybe Text)
- newInstanceConfiguration :: InstanceConfiguration
- data InstanceMetadataOptions = InstanceMetadataOptions' (Maybe Natural) (Maybe Text)
- newInstanceMetadataOptions :: InstanceMetadataOptions
- data LaunchPermissionConfiguration = LaunchPermissionConfiguration' (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe [Text]) (Maybe (NonEmpty Text))
- newLaunchPermissionConfiguration :: LaunchPermissionConfiguration
- data LaunchTemplateConfiguration = LaunchTemplateConfiguration' (Maybe Text) (Maybe Bool) Text
- newLaunchTemplateConfiguration :: Text -> LaunchTemplateConfiguration
- data Logging = Logging' (Maybe S3Logs)
- newLogging :: Logging
- data OutputResources = OutputResources' (Maybe [Ami]) (Maybe [Container])
- newOutputResources :: OutputResources
- data S3ExportConfiguration = S3ExportConfiguration' (Maybe Text) Text DiskImageFormat Text
- newS3ExportConfiguration :: Text -> DiskImageFormat -> Text -> S3ExportConfiguration
- data S3Logs = S3Logs' (Maybe Text) (Maybe Text)
- newS3Logs :: S3Logs
- data Schedule = Schedule' (Maybe PipelineExecutionStartCondition) (Maybe Text) (Maybe Text)
- newSchedule :: Schedule
- data SystemsManagerAgent = SystemsManagerAgent' (Maybe Bool)
- newSystemsManagerAgent :: SystemsManagerAgent
- data TargetContainerRepository = TargetContainerRepository' ContainerRepositoryService Text
- newTargetContainerRepository :: ContainerRepositoryService -> Text -> TargetContainerRepository
Service Configuration
defaultService :: Service Source #
API version 2019-12-02
of the Amazon EC2 Image Builder SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by ImageBuilder
.
CallRateLimitExceededException
_CallRateLimitExceededException :: AsError a => Fold a ServiceError Source #
You have exceeded the permitted request rate for the specific operation.
ClientException
_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
_ForbiddenException :: AsError a => Fold a ServiceError Source #
You are not authorized to perform the requested operation.
IdempotentParameterMismatchException
_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
_InvalidPaginationTokenException :: AsError a => Fold a ServiceError Source #
You have provided an invalid pagination token in your request.
InvalidParameterCombinationException
_InvalidParameterCombinationException :: AsError a => Fold a ServiceError Source #
You have specified two or more mutually exclusive parameters. Review the error message for details.
InvalidParameterException
_InvalidParameterException :: AsError a => Fold a ServiceError Source #
The specified parameter is invalid. Review the available parameters for the API request.
InvalidParameterValueException
_InvalidParameterValueException :: AsError a => Fold a ServiceError Source #
The value that you provided for the specified parameter is invalid.
InvalidRequestException
_InvalidRequestException :: AsError a => Fold a ServiceError Source #
You have made a request for an action that is not supported by the service.
InvalidVersionNumberException
_InvalidVersionNumberException :: AsError a => Fold a ServiceError Source #
Your version number is out of bounds or does not follow the required syntax.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The resource that you are trying to create already exists.
ResourceDependencyException
_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
_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
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
At least one of the resources referenced by your request does not exist.
ServiceException
_ServiceException :: AsError a => Fold a ServiceError Source #
This exception is thrown when the service encounters an unrecoverable exception.
ServiceQuotaExceededException
_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
_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #
The service is unable to process your request at this time.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CancelImageCreation
data CancelImageCreation Source #
See: newCancelImageCreation
smart constructor.
Instances
newCancelImageCreation Source #
Create a value of CancelImageCreation
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:
CancelImageCreation
, cancelImageCreation_imageBuildVersionArn
- The Amazon Resource Name (ARN) of the image whose creation you want to
cancel.
CancelImageCreation
, cancelImageCreation_clientToken
- Unique, case-sensitive identifier you provide to ensure idempotency of
the request. For more information, see
Ensuring idempotency
in the Amazon EC2 API Reference.
data CancelImageCreationResponse Source #
See: newCancelImageCreationResponse
smart constructor.
Instances
newCancelImageCreationResponse Source #
Create a value of CancelImageCreationResponse
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:
CancelImageCreation
, cancelImageCreationResponse_clientToken
- The idempotency token that was used for this request.
CancelImageCreation
, cancelImageCreationResponse_imageBuildVersionArn
- The Amazon Resource Name (ARN) of the image whose creation has been
cancelled.
$sel:requestId:CancelImageCreationResponse'
, cancelImageCreationResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:CancelImageCreationResponse'
, cancelImageCreationResponse_httpStatus
- The response's http status code.
CreateComponent
data CreateComponent Source #
See: newCreateComponent
smart constructor.
CreateComponent' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (HashMap Text Text)) (Maybe Text) Text Text Platform Text |
Instances
:: Text | |
-> Text | |
-> Platform | |
-> Text | |
-> CreateComponent |
Create a value of CreateComponent
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:
CreateComponent
, createComponent_changeDescription
- The change description of the component. Describes what change has been
made in this version, or what makes this version different from other
versions of this component.
CreateComponent
, createComponent_data
- Component data
contains inline YAML document content for the
component. Alternatively, you can specify the uri
of a YAML document
file stored in Amazon S3. However, you cannot specify both properties.
CreateComponent
, createComponent_description
- The description of the component. Describes the contents of the
component.
CreateComponent
, createComponent_kmsKeyId
- The ID of the KMS key that should be used to encrypt this component.
CreateComponent
, createComponent_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.
CreateComponent
, createComponent_tags
- The tags of the component.
$sel:uri:CreateComponent'
, createComponent_uri
- The uri
of a YAML component document file. This must be an S3 URL
(s3://bucket/key
), and the requester must have permission to access
the S3 bucket it points to. If you use Amazon S3, you can specify
component content up to your service quota.
Alternatively, you can specify the YAML document inline, using the
component data
property. You cannot specify both properties.
CreateComponent
, createComponent_name
- The name of the component.
$sel:semanticVersion:CreateComponent'
, createComponent_semanticVersion
- The semantic version of the component. 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.
CreateComponent
, createComponent_platform
- The platform of the component.
CreateComponent
, createComponent_clientToken
- The idempotency token of the component.
data CreateComponentResponse Source #
See: newCreateComponentResponse
smart constructor.
Instances
newCreateComponentResponse Source #
Create a value of CreateComponentResponse
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:
CreateComponent
, createComponentResponse_clientToken
- The idempotency token used to make this request idempotent.
$sel:componentBuildVersionArn:CreateComponentResponse'
, createComponentResponse_componentBuildVersionArn
- The Amazon Resource Name (ARN) of the component that was created by this
request.
$sel:requestId:CreateComponentResponse'
, createComponentResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:CreateComponentResponse'
, createComponentResponse_httpStatus
- The response's http status code.
CreateContainerRecipe
data CreateContainerRecipe Source #
See: newCreateContainerRecipe
smart constructor.
Instances
newCreateContainerRecipe Source #
:: ContainerType | |
-> Text | |
-> Text | |
-> NonEmpty ComponentConfiguration | |
-> Text | |
-> TargetContainerRepository | |
-> Text | |
-> CreateContainerRecipe |
Create a value of CreateContainerRecipe
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:
CreateContainerRecipe
, createContainerRecipe_description
- The description of the container recipe.
CreateContainerRecipe
, createContainerRecipe_dockerfileTemplateData
- The Dockerfile template used to build your image as an inline data blob.
$sel:dockerfileTemplateUri:CreateContainerRecipe'
, createContainerRecipe_dockerfileTemplateUri
- The Amazon S3 URI for the Dockerfile that will be used to build your
container image.
$sel:imageOsVersionOverride:CreateContainerRecipe'
, createContainerRecipe_imageOsVersionOverride
- Specifies the operating system version for the base image.
CreateContainerRecipe
, createContainerRecipe_instanceConfiguration
- A group of options that can be used to configure an instance for
building and testing container images.
CreateContainerRecipe
, createContainerRecipe_kmsKeyId
- Identifies which KMS key is used to encrypt the container image.
$sel:platformOverride:CreateContainerRecipe'
, createContainerRecipe_platformOverride
- Specifies the operating system platform when you use a custom base
image.
CreateContainerRecipe
, createContainerRecipe_tags
- Tags that are attached to the container recipe.
CreateContainerRecipe
, createContainerRecipe_workingDirectory
- The working directory for use during build and test workflows.
CreateContainerRecipe
, createContainerRecipe_containerType
- The type of container to create.
CreateContainerRecipe
, createContainerRecipe_name
- The name of the container recipe.
$sel:semanticVersion:CreateContainerRecipe'
, createContainerRecipe_semanticVersion
- The semantic version of the container recipe. 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.
CreateContainerRecipe
, createContainerRecipe_components
- Components for build and test that are included in the container recipe.
CreateContainerRecipe
, createContainerRecipe_parentImage
- The base image for the container recipe.
CreateContainerRecipe
, createContainerRecipe_targetRepository
- The destination repository for the container image.
CreateContainerRecipe
, createContainerRecipe_clientToken
- The client token used to make this request idempotent.
data CreateContainerRecipeResponse Source #
See: newCreateContainerRecipeResponse
smart constructor.
Instances
newCreateContainerRecipeResponse Source #
Create a value of CreateContainerRecipeResponse
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:
CreateContainerRecipe
, createContainerRecipeResponse_clientToken
- The client token used to make this request idempotent.
CreateContainerRecipeResponse
, createContainerRecipeResponse_containerRecipeArn
- Returns the Amazon Resource Name (ARN) of the container recipe that the
request created.
$sel:requestId:CreateContainerRecipeResponse'
, createContainerRecipeResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:CreateContainerRecipeResponse'
, createContainerRecipeResponse_httpStatus
- The response's http status code.
CreateDistributionConfiguration
data CreateDistributionConfiguration Source #
See: newCreateDistributionConfiguration
smart constructor.
Instances
newCreateDistributionConfiguration Source #
Create a value of CreateDistributionConfiguration
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:
CreateDistributionConfiguration
, createDistributionConfiguration_description
- The description of the distribution configuration.
CreateDistributionConfiguration
, createDistributionConfiguration_tags
- The tags of the distribution configuration.
CreateDistributionConfiguration
, createDistributionConfiguration_name
- The name of the distribution configuration.
CreateDistributionConfiguration
, createDistributionConfiguration_distributions
- The distributions of the distribution configuration.
CreateDistributionConfiguration
, createDistributionConfiguration_clientToken
- The idempotency token of the distribution configuration.
data CreateDistributionConfigurationResponse Source #
See: newCreateDistributionConfigurationResponse
smart constructor.
Instances
newCreateDistributionConfigurationResponse Source #
Create a value of CreateDistributionConfigurationResponse
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:
CreateDistributionConfiguration
, createDistributionConfigurationResponse_clientToken
- The idempotency token used to make this request idempotent.
CreateDistributionConfigurationResponse
, createDistributionConfigurationResponse_distributionConfigurationArn
- The Amazon Resource Name (ARN) of the distribution configuration that
was created by this request.
$sel:requestId:CreateDistributionConfigurationResponse'
, createDistributionConfigurationResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:CreateDistributionConfigurationResponse'
, createDistributionConfigurationResponse_httpStatus
- The response's http status code.
CreateImage
data CreateImage Source #
See: newCreateImage
smart constructor.
CreateImage' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe ImageTestsConfiguration) (Maybe (HashMap Text Text)) Text Text |
Instances
Create a value of CreateImage
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:
CreateImage
, createImage_containerRecipeArn
- The Amazon Resource Name (ARN) of the container recipe that defines how
images are configured and tested.
CreateImage
, createImage_distributionConfigurationArn
- The Amazon Resource Name (ARN) of the distribution configuration that
defines and configures the outputs of your pipeline.
CreateImage
, createImage_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.
CreateImage
, createImage_imageRecipeArn
- The Amazon Resource Name (ARN) of the image recipe that defines how
images are configured, tested, and assessed.
CreateImage
, createImage_imageTestsConfiguration
- The image tests configuration of the image.
CreateImage
, createImage_tags
- The tags of the image.
CreateImage
, createImage_infrastructureConfigurationArn
- The Amazon Resource Name (ARN) of the infrastructure configuration that
defines the environment in which your image will be built and tested.
CreateImage
, createImage_clientToken
- The idempotency token used to make this request idempotent.
data CreateImageResponse Source #
See: newCreateImageResponse
smart constructor.
Instances
newCreateImageResponse Source #
Create a value of CreateImageResponse
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:
CreateImage
, createImageResponse_clientToken
- The idempotency token used to make this request idempotent.
$sel:imageBuildVersionArn:CreateImageResponse'
, createImageResponse_imageBuildVersionArn
- The Amazon Resource Name (ARN) of the image that was created by this
request.
$sel:requestId:CreateImageResponse'
, createImageResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:CreateImageResponse'
, createImageResponse_httpStatus
- The response's http status code.
CreateImagePipeline
data CreateImagePipeline Source #
See: newCreateImagePipeline
smart constructor.
CreateImagePipeline' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe ImageTestsConfiguration) (Maybe Schedule) (Maybe PipelineStatus) (Maybe (HashMap Text Text)) Text Text Text |
Instances
newCreateImagePipeline Source #
:: Text | |
-> Text | |
-> Text | |
-> CreateImagePipeline |
Create a value of CreateImagePipeline
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:
CreateImagePipeline
, createImagePipeline_containerRecipeArn
- The Amazon Resource Name (ARN) of the container recipe that is used to
configure images created by this container pipeline.
CreateImagePipeline
, createImagePipeline_description
- The description of the image pipeline.
CreateImagePipeline
, createImagePipeline_distributionConfigurationArn
- The Amazon Resource Name (ARN) of the distribution configuration that
will be used to configure and distribute images created by this image
pipeline.
CreateImagePipeline
, createImagePipeline_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.
CreateImagePipeline
, createImagePipeline_imageRecipeArn
- The Amazon Resource Name (ARN) of the image recipe that will be used to
configure images created by this image pipeline.
CreateImagePipeline
, createImagePipeline_imageTestsConfiguration
- The image test configuration of the image pipeline.
CreateImagePipeline
, createImagePipeline_schedule
- The schedule of the image pipeline.
CreateImagePipeline
, createImagePipeline_status
- The status of the image pipeline.
CreateImagePipeline
, createImagePipeline_tags
- The tags of the image pipeline.
CreateImagePipeline
, createImagePipeline_name
- The name of the image pipeline.
CreateImagePipeline
, createImagePipeline_infrastructureConfigurationArn
- The Amazon Resource Name (ARN) of the infrastructure configuration that
will be used to build images created by this image pipeline.
CreateImagePipeline
, createImagePipeline_clientToken
- The idempotency token used to make this request idempotent.
data CreateImagePipelineResponse Source #
See: newCreateImagePipelineResponse
smart constructor.
Instances
newCreateImagePipelineResponse Source #
Create a value of CreateImagePipelineResponse
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:
CreateImagePipeline
, createImagePipelineResponse_clientToken
- The idempotency token used to make this request idempotent.
$sel:imagePipelineArn:CreateImagePipelineResponse'
, createImagePipelineResponse_imagePipelineArn
- The Amazon Resource Name (ARN) of the image pipeline that was created by
this request.
$sel:requestId:CreateImagePipelineResponse'
, createImagePipelineResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:CreateImagePipelineResponse'
, createImagePipelineResponse_httpStatus
- The response's http status code.
CreateImageRecipe
data CreateImageRecipe Source #
See: newCreateImageRecipe
smart constructor.
Instances
:: Text | |
-> Text | |
-> NonEmpty ComponentConfiguration | |
-> Text | |
-> Text | |
-> CreateImageRecipe |
Create a value of CreateImageRecipe
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:
CreateImageRecipe
, createImageRecipe_additionalInstanceConfiguration
- Specify additional settings and launch scripts for your build instances.
CreateImageRecipe
, createImageRecipe_blockDeviceMappings
- The block device mappings of the image recipe.
CreateImageRecipe
, createImageRecipe_description
- The description of the image recipe.
CreateImageRecipe
, createImageRecipe_tags
- The tags of the image recipe.
CreateImageRecipe
, createImageRecipe_workingDirectory
- The working directory used during build and test workflows.
CreateImageRecipe
, createImageRecipe_name
- The name of the image recipe.
$sel:semanticVersion:CreateImageRecipe'
, createImageRecipe_semanticVersion
- The semantic version of the image recipe. 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.
CreateImageRecipe
, createImageRecipe_components
- The components of the image recipe.
CreateImageRecipe
, createImageRecipe_parentImage
- The base image of the image recipe. The value of the string can be the
ARN of the base image or an AMI ID. The format for the ARN follows this
example:
arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x
.
You can provide the specific version that you want to use, or you can
use a wildcard in all of the fields. If you enter an AMI ID for the
string value, you must have access to the AMI, and the AMI must be in
the same Region in which you are using Image Builder.
CreateImageRecipe
, createImageRecipe_clientToken
- The idempotency token used to make this request idempotent.
data CreateImageRecipeResponse Source #
See: newCreateImageRecipeResponse
smart constructor.
Instances
newCreateImageRecipeResponse Source #
Create a value of CreateImageRecipeResponse
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:
CreateImageRecipe
, createImageRecipeResponse_clientToken
- The idempotency token used to make this request idempotent.
CreateImageRecipeResponse
, createImageRecipeResponse_imageRecipeArn
- The Amazon Resource Name (ARN) of the image recipe that was created by
this request.
$sel:requestId:CreateImageRecipeResponse'
, createImageRecipeResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:CreateImageRecipeResponse'
, createImageRecipeResponse_httpStatus
- The response's http status code.
CreateInfrastructureConfiguration
data CreateInfrastructureConfiguration Source #
See: newCreateInfrastructureConfiguration
smart constructor.
CreateInfrastructureConfiguration' (Maybe Text) (Maybe InstanceMetadataOptions) (Maybe [Text]) (Maybe Text) (Maybe Logging) (Maybe (HashMap Text Text)) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Bool) Text Text Text |
Instances
newCreateInfrastructureConfiguration Source #
:: Text | |
-> Text | |
-> Text | |
-> CreateInfrastructureConfiguration |
Create a value of CreateInfrastructureConfiguration
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:
CreateInfrastructureConfiguration
, createInfrastructureConfiguration_description
- The description of the infrastructure configuration.
CreateInfrastructureConfiguration
, createInfrastructureConfiguration_instanceMetadataOptions
- The instance metadata options that you can set for the HTTP requests
that pipeline builds use to launch EC2 build and test instances.
CreateInfrastructureConfiguration
, createInfrastructureConfiguration_instanceTypes
- The instance types of the infrastructure configuration. You can specify
one or more instance types to use for this build. The service will pick
one of these instance types based on availability.
CreateInfrastructureConfiguration
, createInfrastructureConfiguration_keyPair
- The key pair of the infrastructure configuration. You can use this to
log on to and debug the instance used to create your image.
CreateInfrastructureConfiguration
, createInfrastructureConfiguration_logging
- The logging configuration of the infrastructure configuration.
CreateInfrastructureConfiguration
, createInfrastructureConfiguration_resourceTags
- The tags attached to the resource created by Image Builder.
CreateInfrastructureConfiguration
, createInfrastructureConfiguration_securityGroupIds
- The security group IDs to associate with the instance used to customize
your Amazon EC2 AMI.
CreateInfrastructureConfiguration
, createInfrastructureConfiguration_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.
CreateInfrastructureConfiguration
, createInfrastructureConfiguration_subnetId
- The subnet ID in which to place the instance used to customize your
Amazon EC2 AMI.
CreateInfrastructureConfiguration
, createInfrastructureConfiguration_tags
- The tags of the infrastructure configuration.
CreateInfrastructureConfiguration
, createInfrastructureConfiguration_terminateInstanceOnFailure
- The terminate instance on failure setting of the infrastructure
configuration. Set to false if you want Image Builder to retain the
instance used to configure your AMI if the build or test phase of your
workflow fails.
CreateInfrastructureConfiguration
, createInfrastructureConfiguration_name
- The name of the infrastructure configuration.
CreateInfrastructureConfiguration
, createInfrastructureConfiguration_instanceProfileName
- The instance profile to associate with the instance used to customize
your Amazon EC2 AMI.
CreateInfrastructureConfiguration
, createInfrastructureConfiguration_clientToken
- The idempotency token used to make this request idempotent.
data CreateInfrastructureConfigurationResponse Source #
See: newCreateInfrastructureConfigurationResponse
smart constructor.
Instances
newCreateInfrastructureConfigurationResponse Source #
Create a value of CreateInfrastructureConfigurationResponse
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:
CreateInfrastructureConfiguration
, createInfrastructureConfigurationResponse_clientToken
- The idempotency token used to make this request idempotent.
CreateInfrastructureConfigurationResponse
, createInfrastructureConfigurationResponse_infrastructureConfigurationArn
- The Amazon Resource Name (ARN) of the infrastructure configuration that
was created by this request.
$sel:requestId:CreateInfrastructureConfigurationResponse'
, createInfrastructureConfigurationResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:CreateInfrastructureConfigurationResponse'
, createInfrastructureConfigurationResponse_httpStatus
- The response's http status code.
DeleteComponent
data DeleteComponent Source #
See: newDeleteComponent
smart constructor.
Instances
Create a value of DeleteComponent
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:
DeleteComponent
, deleteComponent_componentBuildVersionArn
- The Amazon Resource Name (ARN) of the component build version to delete.
data DeleteComponentResponse Source #
See: newDeleteComponentResponse
smart constructor.
Instances
newDeleteComponentResponse Source #
Create a value of DeleteComponentResponse
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:
DeleteComponent
, deleteComponentResponse_componentBuildVersionArn
- The Amazon Resource Name (ARN) of the component build version that was
deleted.
$sel:requestId:DeleteComponentResponse'
, deleteComponentResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:DeleteComponentResponse'
, deleteComponentResponse_httpStatus
- The response's http status code.
DeleteContainerRecipe
data DeleteContainerRecipe Source #
See: newDeleteContainerRecipe
smart constructor.
Instances
newDeleteContainerRecipe Source #
Create a value of DeleteContainerRecipe
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:
DeleteContainerRecipe
, deleteContainerRecipe_containerRecipeArn
- The Amazon Resource Name (ARN) of the container recipe to delete.
data DeleteContainerRecipeResponse Source #
See: newDeleteContainerRecipeResponse
smart constructor.
Instances
newDeleteContainerRecipeResponse Source #
Create a value of DeleteContainerRecipeResponse
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:
DeleteContainerRecipe
, deleteContainerRecipeResponse_containerRecipeArn
- The Amazon Resource Name (ARN) of the container recipe that was deleted.
$sel:requestId:DeleteContainerRecipeResponse'
, deleteContainerRecipeResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:DeleteContainerRecipeResponse'
, deleteContainerRecipeResponse_httpStatus
- The response's http status code.
DeleteDistributionConfiguration
data DeleteDistributionConfiguration Source #
See: newDeleteDistributionConfiguration
smart constructor.
Instances
newDeleteDistributionConfiguration Source #
Create a value of DeleteDistributionConfiguration
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:
DeleteDistributionConfiguration
, deleteDistributionConfiguration_distributionConfigurationArn
- The Amazon Resource Name (ARN) of the distribution configuration to
delete.
data DeleteDistributionConfigurationResponse Source #
See: newDeleteDistributionConfigurationResponse
smart constructor.
Instances
newDeleteDistributionConfigurationResponse Source #
Create a value of DeleteDistributionConfigurationResponse
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:
DeleteDistributionConfiguration
, deleteDistributionConfigurationResponse_distributionConfigurationArn
- The Amazon Resource Name (ARN) of the distribution configuration that
was deleted.
$sel:requestId:DeleteDistributionConfigurationResponse'
, deleteDistributionConfigurationResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:DeleteDistributionConfigurationResponse'
, deleteDistributionConfigurationResponse_httpStatus
- The response's http status code.
DeleteImage
data DeleteImage Source #
See: newDeleteImage
smart constructor.
Instances
Create a value of DeleteImage
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:
DeleteImage
, deleteImage_imageBuildVersionArn
- The Amazon Resource Name (ARN) of the Image Builder image resource to
delete.
data DeleteImageResponse Source #
See: newDeleteImageResponse
smart constructor.
Instances
newDeleteImageResponse Source #
Create a value of DeleteImageResponse
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:
DeleteImage
, deleteImageResponse_imageBuildVersionArn
- The Amazon Resource Name (ARN) of the Image Builder image resource that
was deleted.
$sel:requestId:DeleteImageResponse'
, deleteImageResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:DeleteImageResponse'
, deleteImageResponse_httpStatus
- The response's http status code.
DeleteImagePipeline
data DeleteImagePipeline Source #
See: newDeleteImagePipeline
smart constructor.
Instances
newDeleteImagePipeline Source #
Create a value of DeleteImagePipeline
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:
DeleteImagePipeline
, deleteImagePipeline_imagePipelineArn
- The Amazon Resource Name (ARN) of the image pipeline to delete.
data DeleteImagePipelineResponse Source #
See: newDeleteImagePipelineResponse
smart constructor.
Instances
newDeleteImagePipelineResponse Source #
Create a value of DeleteImagePipelineResponse
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:
DeleteImagePipeline
, deleteImagePipelineResponse_imagePipelineArn
- The Amazon Resource Name (ARN) of the image pipeline that was deleted.
$sel:requestId:DeleteImagePipelineResponse'
, deleteImagePipelineResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:DeleteImagePipelineResponse'
, deleteImagePipelineResponse_httpStatus
- The response's http status code.
DeleteImageRecipe
data DeleteImageRecipe Source #
See: newDeleteImageRecipe
smart constructor.
Instances
Create a value of DeleteImageRecipe
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:
DeleteImageRecipe
, deleteImageRecipe_imageRecipeArn
- The Amazon Resource Name (ARN) of the image recipe to delete.
data DeleteImageRecipeResponse Source #
See: newDeleteImageRecipeResponse
smart constructor.
Instances
newDeleteImageRecipeResponse Source #
Create a value of DeleteImageRecipeResponse
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:
DeleteImageRecipe
, deleteImageRecipeResponse_imageRecipeArn
- The Amazon Resource Name (ARN) of the image recipe that was deleted.
$sel:requestId:DeleteImageRecipeResponse'
, deleteImageRecipeResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:DeleteImageRecipeResponse'
, deleteImageRecipeResponse_httpStatus
- The response's http status code.
DeleteInfrastructureConfiguration
data DeleteInfrastructureConfiguration Source #
See: newDeleteInfrastructureConfiguration
smart constructor.
Instances
newDeleteInfrastructureConfiguration Source #
Create a value of DeleteInfrastructureConfiguration
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:
DeleteInfrastructureConfiguration
, deleteInfrastructureConfiguration_infrastructureConfigurationArn
- The Amazon Resource Name (ARN) of the infrastructure configuration to
delete.
data DeleteInfrastructureConfigurationResponse Source #
See: newDeleteInfrastructureConfigurationResponse
smart constructor.
Instances
newDeleteInfrastructureConfigurationResponse Source #
Create a value of DeleteInfrastructureConfigurationResponse
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:
DeleteInfrastructureConfiguration
, deleteInfrastructureConfigurationResponse_infrastructureConfigurationArn
- The Amazon Resource Name (ARN) of the infrastructure configuration that
was deleted.
$sel:requestId:DeleteInfrastructureConfigurationResponse'
, deleteInfrastructureConfigurationResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:DeleteInfrastructureConfigurationResponse'
, deleteInfrastructureConfigurationResponse_httpStatus
- The response's http status code.
GetComponent
data GetComponent Source #
See: newGetComponent
smart constructor.
Instances
Create a value of GetComponent
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:componentBuildVersionArn:GetComponent'
, getComponent_componentBuildVersionArn
- The Amazon Resource Name (ARN) of the component that you want to
retrieve. Regex requires "/\d+$" suffix.
data GetComponentResponse Source #
See: newGetComponentResponse
smart constructor.
Instances
newGetComponentResponse Source #
Create a value of GetComponentResponse
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:component:GetComponentResponse'
, getComponentResponse_component
- The component object associated with the specified ARN.
$sel:requestId:GetComponentResponse'
, getComponentResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:GetComponentResponse'
, getComponentResponse_httpStatus
- The response's http status code.
GetComponentPolicy
data GetComponentPolicy Source #
See: newGetComponentPolicy
smart constructor.
Instances
newGetComponentPolicy Source #
Create a value of GetComponentPolicy
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:
GetComponentPolicy
, getComponentPolicy_componentArn
- The Amazon Resource Name (ARN) of the component whose policy you want to
retrieve.
data GetComponentPolicyResponse Source #
See: newGetComponentPolicyResponse
smart constructor.
Instances
newGetComponentPolicyResponse Source #
Create a value of GetComponentPolicyResponse
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:policy:GetComponentPolicyResponse'
, getComponentPolicyResponse_policy
- The component policy.
$sel:requestId:GetComponentPolicyResponse'
, getComponentPolicyResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:GetComponentPolicyResponse'
, getComponentPolicyResponse_httpStatus
- The response's http status code.
GetContainerRecipe
data GetContainerRecipe Source #
See: newGetContainerRecipe
smart constructor.
Instances
newGetContainerRecipe Source #
Create a value of GetContainerRecipe
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:
GetContainerRecipe
, getContainerRecipe_containerRecipeArn
- The Amazon Resource Name (ARN) of the container recipe to retrieve.
data GetContainerRecipeResponse Source #
See: newGetContainerRecipeResponse
smart constructor.
Instances
newGetContainerRecipeResponse Source #
Create a value of GetContainerRecipeResponse
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:
GetContainerRecipeResponse
, getContainerRecipeResponse_containerRecipe
- The container recipe object that is returned.
$sel:requestId:GetContainerRecipeResponse'
, getContainerRecipeResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:GetContainerRecipeResponse'
, getContainerRecipeResponse_httpStatus
- The response's http status code.
GetContainerRecipePolicy
data GetContainerRecipePolicy Source #
See: newGetContainerRecipePolicy
smart constructor.
Instances
newGetContainerRecipePolicy Source #
Create a value of GetContainerRecipePolicy
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:
GetContainerRecipePolicy
, getContainerRecipePolicy_containerRecipeArn
- The Amazon Resource Name (ARN) of the container recipe for the policy
being requested.
data GetContainerRecipePolicyResponse Source #
See: newGetContainerRecipePolicyResponse
smart constructor.
Instances
newGetContainerRecipePolicyResponse Source #
Create a value of GetContainerRecipePolicyResponse
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:policy:GetContainerRecipePolicyResponse'
, getContainerRecipePolicyResponse_policy
- The container recipe policy object that is returned.
$sel:requestId:GetContainerRecipePolicyResponse'
, getContainerRecipePolicyResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:GetContainerRecipePolicyResponse'
, getContainerRecipePolicyResponse_httpStatus
- The response's http status code.
GetDistributionConfiguration
data GetDistributionConfiguration Source #
See: newGetDistributionConfiguration
smart constructor.
Instances
newGetDistributionConfiguration Source #
Create a value of GetDistributionConfiguration
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:
GetDistributionConfiguration
, getDistributionConfiguration_distributionConfigurationArn
- The Amazon Resource Name (ARN) of the distribution configuration that
you want to retrieve.
data GetDistributionConfigurationResponse Source #
See: newGetDistributionConfigurationResponse
smart constructor.
Instances
newGetDistributionConfigurationResponse Source #
Create a value of GetDistributionConfigurationResponse
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:
GetDistributionConfigurationResponse
, getDistributionConfigurationResponse_distributionConfiguration
- The distribution configuration object.
$sel:requestId:GetDistributionConfigurationResponse'
, getDistributionConfigurationResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:GetDistributionConfigurationResponse'
, getDistributionConfigurationResponse_httpStatus
- The response's http status code.
GetImage
See: newGetImage
smart constructor.
Instances
Create a value of GetImage
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:imageBuildVersionArn:GetImage'
, getImage_imageBuildVersionArn
- The Amazon Resource Name (ARN) of the image that you want to retrieve.
data GetImageResponse Source #
See: newGetImageResponse
smart constructor.
Instances
Create a value of GetImageResponse
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:
GetImageResponse
, getImageResponse_image
- The image object.
$sel:requestId:GetImageResponse'
, getImageResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:GetImageResponse'
, getImageResponse_httpStatus
- The response's http status code.
GetImagePipeline
data GetImagePipeline Source #
See: newGetImagePipeline
smart constructor.
Instances
Create a value of GetImagePipeline
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:imagePipelineArn:GetImagePipeline'
, getImagePipeline_imagePipelineArn
- The Amazon Resource Name (ARN) of the image pipeline that you want to
retrieve.
data GetImagePipelineResponse Source #
See: newGetImagePipelineResponse
smart constructor.
Instances
newGetImagePipelineResponse Source #
Create a value of GetImagePipelineResponse
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:imagePipeline:GetImagePipelineResponse'
, getImagePipelineResponse_imagePipeline
- The image pipeline object.
$sel:requestId:GetImagePipelineResponse'
, getImagePipelineResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:GetImagePipelineResponse'
, getImagePipelineResponse_httpStatus
- The response's http status code.
GetImagePolicy
data GetImagePolicy Source #
See: newGetImagePolicy
smart constructor.
Instances
Create a value of GetImagePolicy
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:imageArn:GetImagePolicy'
, getImagePolicy_imageArn
- The Amazon Resource Name (ARN) of the image whose policy you want to
retrieve.
data GetImagePolicyResponse Source #
See: newGetImagePolicyResponse
smart constructor.
Instances
newGetImagePolicyResponse Source #
Create a value of GetImagePolicyResponse
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:policy:GetImagePolicyResponse'
, getImagePolicyResponse_policy
- The image policy object.
$sel:requestId:GetImagePolicyResponse'
, getImagePolicyResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:GetImagePolicyResponse'
, getImagePolicyResponse_httpStatus
- The response's http status code.
GetImageRecipe
data GetImageRecipe Source #
See: newGetImageRecipe
smart constructor.
Instances
Create a value of GetImageRecipe
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:
GetImageRecipe
, getImageRecipe_imageRecipeArn
- The Amazon Resource Name (ARN) of the image recipe that you want to
retrieve.
data GetImageRecipeResponse Source #
See: newGetImageRecipeResponse
smart constructor.
Instances
newGetImageRecipeResponse Source #
Create a value of GetImageRecipeResponse
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:
GetImageRecipeResponse
, getImageRecipeResponse_imageRecipe
- The image recipe object.
$sel:requestId:GetImageRecipeResponse'
, getImageRecipeResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:GetImageRecipeResponse'
, getImageRecipeResponse_httpStatus
- The response's http status code.
GetImageRecipePolicy
data GetImageRecipePolicy Source #
See: newGetImageRecipePolicy
smart constructor.
Instances
newGetImageRecipePolicy Source #
Create a value of GetImageRecipePolicy
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:
GetImageRecipePolicy
, getImageRecipePolicy_imageRecipeArn
- The Amazon Resource Name (ARN) of the image recipe whose policy you want
to retrieve.
data GetImageRecipePolicyResponse Source #
See: newGetImageRecipePolicyResponse
smart constructor.
Instances
newGetImageRecipePolicyResponse Source #
Create a value of GetImageRecipePolicyResponse
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:policy:GetImageRecipePolicyResponse'
, getImageRecipePolicyResponse_policy
- The image recipe policy object.
$sel:requestId:GetImageRecipePolicyResponse'
, getImageRecipePolicyResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:GetImageRecipePolicyResponse'
, getImageRecipePolicyResponse_httpStatus
- The response's http status code.
GetInfrastructureConfiguration
data GetInfrastructureConfiguration Source #
GetInfrastructureConfiguration request object.
See: newGetInfrastructureConfiguration
smart constructor.
Instances
newGetInfrastructureConfiguration Source #
Create a value of GetInfrastructureConfiguration
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:
GetInfrastructureConfiguration
, getInfrastructureConfiguration_infrastructureConfigurationArn
- The Amazon Resource Name (ARN) of the infrastructure configuration that
you want to retrieve.
data GetInfrastructureConfigurationResponse Source #
GetInfrastructureConfiguration response object.
See: newGetInfrastructureConfigurationResponse
smart constructor.
Instances
newGetInfrastructureConfigurationResponse Source #
Create a value of GetInfrastructureConfigurationResponse
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:
GetInfrastructureConfigurationResponse
, getInfrastructureConfigurationResponse_infrastructureConfiguration
- The infrastructure configuration object.
$sel:requestId:GetInfrastructureConfigurationResponse'
, getInfrastructureConfigurationResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:GetInfrastructureConfigurationResponse'
, getInfrastructureConfigurationResponse_httpStatus
- The response's http status code.
ImportComponent
data ImportComponent Source #
See: newImportComponent
smart constructor.
ImportComponent' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) Text Text ComponentType ComponentFormat Platform Text |
Instances
:: Text | |
-> Text | |
-> ComponentType | |
-> ComponentFormat | |
-> Platform | |
-> Text | |
-> ImportComponent |
Create a value of ImportComponent
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:
ImportComponent
, importComponent_changeDescription
- The change description of the component. Describes what change has been
made in this version, or what makes this version different from other
versions of this component.
ImportComponent
, importComponent_data
- The data of the component. Used to specify the data inline. Either
data
or uri
can be used to specify the data within the component.
ImportComponent
, importComponent_description
- The description of the component. Describes the contents of the
component.
ImportComponent
, importComponent_kmsKeyId
- The ID of the KMS key that should be used to encrypt this component.
ImportComponent
, importComponent_tags
- The tags of the component.
$sel:uri:ImportComponent'
, importComponent_uri
- The uri of the component. Must be an Amazon S3 URL and the requester
must have permission to access the Amazon S3 bucket. If you use Amazon
S3, you can specify component content up to your service quota. Either
data
or uri
can be used to specify the data within the component.
ImportComponent
, importComponent_name
- The name of the component.
$sel:semanticVersion:ImportComponent'
, importComponent_semanticVersion
- The semantic version of the component. 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.
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.
ImportComponent
, importComponent_type
- The type of the component denotes whether the component is used to build
the image, or only to test it.
$sel:format:ImportComponent'
, importComponent_format
- The format of the resource that you want to import as a component.
ImportComponent
, importComponent_platform
- The platform of the component.
ImportComponent
, importComponent_clientToken
- The idempotency token of the component.
data ImportComponentResponse Source #
See: newImportComponentResponse
smart constructor.
Instances
newImportComponentResponse Source #
Create a value of ImportComponentResponse
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:
ImportComponent
, importComponentResponse_clientToken
- The idempotency token used to make this request idempotent.
$sel:componentBuildVersionArn:ImportComponentResponse'
, importComponentResponse_componentBuildVersionArn
- The Amazon Resource Name (ARN) of the imported component.
$sel:requestId:ImportComponentResponse'
, importComponentResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:ImportComponentResponse'
, importComponentResponse_httpStatus
- The response's http status code.
ImportVmImage
data ImportVmImage Source #
See: newImportVmImage
smart constructor.
Instances
Create a value of ImportVmImage
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:
ImportVmImage
, importVmImage_description
- The description for the base image that is created by the import
process.
ImportVmImage
, importVmImage_osVersion
- The operating system version for the imported VM.
ImportVmImage
, importVmImage_tags
- Tags that are attached to the import resources.
ImportVmImage
, importVmImage_name
- The name of the base image that is created by the import process.
$sel:semanticVersion:ImportVmImage'
, importVmImage_semanticVersion
- The semantic version to attach to the base image that was created during
the import process. 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.
ImportVmImage
, importVmImage_platform
- The operating system platform for the imported VM.
$sel:vmImportTaskId:ImportVmImage'
, importVmImage_vmImportTaskId
- The importTaskId
(API) or ImportTaskId
(CLI) from the Amazon EC2 VM
import process. Image Builder retrieves information from the import
process to pull in the AMI that is created from the VM source as the
base image for your recipe.
ImportVmImage
, importVmImage_clientToken
- Unique, case-sensitive identifier you provide to ensure idempotency of
the request. For more information, see
Ensuring idempotency
in the Amazon EC2 API Reference.
data ImportVmImageResponse Source #
See: newImportVmImageResponse
smart constructor.
Instances
newImportVmImageResponse Source #
Create a value of ImportVmImageResponse
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:
ImportVmImage
, importVmImageResponse_clientToken
- The idempotency token that was used for this request.
$sel:imageArn:ImportVmImageResponse'
, importVmImageResponse_imageArn
- The Amazon Resource Name (ARN) of the AMI that was created during the VM
import process. This AMI is used as the base image for the recipe that
imported the VM.
$sel:requestId:ImportVmImageResponse'
, importVmImageResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:ImportVmImageResponse'
, importVmImageResponse_httpStatus
- The response's http status code.
ListComponentBuildVersions
data ListComponentBuildVersions Source #
See: newListComponentBuildVersions
smart constructor.
Instances
newListComponentBuildVersions Source #
Create a value of ListComponentBuildVersions
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:maxResults:ListComponentBuildVersions'
, listComponentBuildVersions_maxResults
- The maximum items to return in a request.
ListComponentBuildVersions
, listComponentBuildVersions_nextToken
- A token to specify where to start paginating. This is the NextToken from
a previously truncated response.
$sel:componentVersionArn:ListComponentBuildVersions'
, listComponentBuildVersions_componentVersionArn
- The component version Amazon Resource Name (ARN) whose versions you want
to list.
data ListComponentBuildVersionsResponse Source #
See: newListComponentBuildVersionsResponse
smart constructor.
Instances
newListComponentBuildVersionsResponse Source #
Create a value of ListComponentBuildVersionsResponse
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:componentSummaryList:ListComponentBuildVersionsResponse'
, listComponentBuildVersionsResponse_componentSummaryList
- The list of component summaries for the specified semantic version.
ListComponentBuildVersions
, listComponentBuildVersionsResponse_nextToken
- The next token used for paginated responses. When this is not empty,
there are additional elements that the service has not included in this
request. Use this token with the next request to retrieve additional
objects.
$sel:requestId:ListComponentBuildVersionsResponse'
, listComponentBuildVersionsResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:ListComponentBuildVersionsResponse'
, listComponentBuildVersionsResponse_httpStatus
- The response's http status code.
ListComponents
data ListComponents Source #
See: newListComponents
smart constructor.
ListComponents' (Maybe Bool) (Maybe (NonEmpty Filter)) (Maybe Natural) (Maybe Text) (Maybe Ownership) |
Instances
newListComponents :: ListComponents Source #
Create a value of ListComponents
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:byName:ListComponents'
, listComponents_byName
- Returns the list of component build versions for the specified name.
$sel:filters:ListComponents'
, listComponents_filters
- Use the following filters to streamline results:
description
name
platform
supportedOsVersion
type
version
$sel:maxResults:ListComponents'
, listComponents_maxResults
- The maximum items to return in a request.
ListComponents
, listComponents_nextToken
- A token to specify where to start paginating. This is the NextToken from
a previously truncated response.
ListComponents
, listComponents_owner
- The owner defines which components you want to list. By default, this
request will only show components owned by your account. You can use
this field to specify if you want to view components owned by yourself,
by Amazon, or those components that have been shared with you by other
customers.
data ListComponentsResponse Source #
See: newListComponentsResponse
smart constructor.
Instances
newListComponentsResponse Source #
Create a value of ListComponentsResponse
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:componentVersionList:ListComponentsResponse'
, listComponentsResponse_componentVersionList
- The list of component semantic versions.
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.
ListComponents
, listComponentsResponse_nextToken
- The next token used for paginated responses. When this is not empty,
there are additional elements that the service has not included in this
request. Use this token with the next request to retrieve additional
objects.
$sel:requestId:ListComponentsResponse'
, listComponentsResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:ListComponentsResponse'
, listComponentsResponse_httpStatus
- The response's http status code.
ListContainerRecipes
data ListContainerRecipes Source #
See: newListContainerRecipes
smart constructor.
Instances
newListContainerRecipes :: ListContainerRecipes Source #
Create a value of ListContainerRecipes
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:filters:ListContainerRecipes'
, listContainerRecipes_filters
- Use the following filters to streamline results:
containerType
name
parentImage
platform
$sel:maxResults:ListContainerRecipes'
, listContainerRecipes_maxResults
- The maximum number of results to return in the list.
ListContainerRecipes
, listContainerRecipes_nextToken
- Provides a token for pagination, which determines where to begin the
next set of results when the current set reaches the maximum for one
request.
ListContainerRecipes
, listContainerRecipes_owner
- Returns container recipes belonging to the specified owner, that have
been shared with you. You can omit this field to return container
recipes belonging to your account.
data ListContainerRecipesResponse Source #
See: newListContainerRecipesResponse
smart constructor.
Instances
newListContainerRecipesResponse Source #
Create a value of ListContainerRecipesResponse
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:containerRecipeSummaryList:ListContainerRecipesResponse'
, listContainerRecipesResponse_containerRecipeSummaryList
- The list of container recipes returned for the request.
ListContainerRecipes
, listContainerRecipesResponse_nextToken
- The next token field is used for paginated responses. When this is not
empty, there are additional container recipes that the service has not
included in this response. Use this token with the next request to
retrieve additional list items.
$sel:requestId:ListContainerRecipesResponse'
, listContainerRecipesResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:ListContainerRecipesResponse'
, listContainerRecipesResponse_httpStatus
- The response's http status code.
ListDistributionConfigurations
data ListDistributionConfigurations Source #
See: newListDistributionConfigurations
smart constructor.
Instances
newListDistributionConfigurations :: ListDistributionConfigurations Source #
Create a value of ListDistributionConfigurations
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:filters:ListDistributionConfigurations'
, listDistributionConfigurations_filters
- You can filter on name
to streamline results.
$sel:maxResults:ListDistributionConfigurations'
, listDistributionConfigurations_maxResults
- The maximum items to return in a request.
ListDistributionConfigurations
, listDistributionConfigurations_nextToken
- A token to specify where to start paginating. This is the NextToken from
a previously truncated response.
data ListDistributionConfigurationsResponse Source #
See: newListDistributionConfigurationsResponse
smart constructor.
ListDistributionConfigurationsResponse' (Maybe [DistributionConfigurationSummary]) (Maybe Text) (Maybe Text) Int |
Instances
newListDistributionConfigurationsResponse Source #
Create a value of ListDistributionConfigurationsResponse
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:distributionConfigurationSummaryList:ListDistributionConfigurationsResponse'
, listDistributionConfigurationsResponse_distributionConfigurationSummaryList
- The list of distributions.
ListDistributionConfigurations
, listDistributionConfigurationsResponse_nextToken
- The next token used for paginated responses. When this is not empty,
there are additional elements that the service has not included in this
request. Use this token with the next request to retrieve additional
objects.
$sel:requestId:ListDistributionConfigurationsResponse'
, listDistributionConfigurationsResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:ListDistributionConfigurationsResponse'
, listDistributionConfigurationsResponse_httpStatus
- The response's http status code.
ListImageBuildVersions
data ListImageBuildVersions Source #
See: newListImageBuildVersions
smart constructor.
Instances
newListImageBuildVersions Source #
Create a value of ListImageBuildVersions
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:filters:ListImageBuildVersions'
, listImageBuildVersions_filters
- Use the following filters to streamline results:
name
osVersion
platform
type
version
$sel:maxResults:ListImageBuildVersions'
, listImageBuildVersions_maxResults
- The maximum items to return in a request.
ListImageBuildVersions
, listImageBuildVersions_nextToken
- A token to specify where to start paginating. This is the NextToken from
a previously truncated response.
$sel:imageVersionArn:ListImageBuildVersions'
, listImageBuildVersions_imageVersionArn
- The Amazon Resource Name (ARN) of the image whose build versions you
want to retrieve.
data ListImageBuildVersionsResponse Source #
See: newListImageBuildVersionsResponse
smart constructor.
Instances
newListImageBuildVersionsResponse Source #
Create a value of ListImageBuildVersionsResponse
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:imageSummaryList:ListImageBuildVersionsResponse'
, listImageBuildVersionsResponse_imageSummaryList
- The list of image build versions.
ListImageBuildVersions
, listImageBuildVersionsResponse_nextToken
- The next token used for paginated responses. When this is not empty,
there are additional elements that the service has not included in this
request. Use this token with the next request to retrieve additional
objects.
$sel:requestId:ListImageBuildVersionsResponse'
, listImageBuildVersionsResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:ListImageBuildVersionsResponse'
, listImageBuildVersionsResponse_httpStatus
- The response's http status code.
ListImagePackages
data ListImagePackages Source #
See: newListImagePackages
smart constructor.
Instances
Create a value of ListImagePackages
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:maxResults:ListImagePackages'
, listImagePackages_maxResults
- The maxiumum number of results to return from the ListImagePackages
request.
ListImagePackages
, listImagePackages_nextToken
- A token to specify where to start paginating. This is the NextToken from
a previously truncated response.
$sel:imageBuildVersionArn:ListImagePackages'
, listImagePackages_imageBuildVersionArn
- Filter results for the ListImagePackages request by the Image Build
Version ARN
data ListImagePackagesResponse Source #
See: newListImagePackagesResponse
smart constructor.
Instances
newListImagePackagesResponse Source #
Create a value of ListImagePackagesResponse
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:imagePackageList:ListImagePackagesResponse'
, listImagePackagesResponse_imagePackageList
- The list of Image Packages returned in the response.
ListImagePackages
, listImagePackagesResponse_nextToken
- A token to specify where to start paginating. This is the NextToken from
a previously truncated response.
$sel:requestId:ListImagePackagesResponse'
, listImagePackagesResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:ListImagePackagesResponse'
, listImagePackagesResponse_httpStatus
- The response's http status code.
ListImagePipelineImages
data ListImagePipelineImages Source #
See: newListImagePipelineImages
smart constructor.
Instances
newListImagePipelineImages Source #
Create a value of ListImagePipelineImages
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:filters:ListImagePipelineImages'
, listImagePipelineImages_filters
- Use the following filters to streamline results:
name
version
$sel:maxResults:ListImagePipelineImages'
, listImagePipelineImages_maxResults
- The maximum items to return in a request.
ListImagePipelineImages
, listImagePipelineImages_nextToken
- A token to specify where to start paginating. This is the NextToken from
a previously truncated response.
$sel:imagePipelineArn:ListImagePipelineImages'
, listImagePipelineImages_imagePipelineArn
- The Amazon Resource Name (ARN) of the image pipeline whose images you
want to view.
data ListImagePipelineImagesResponse Source #
See: newListImagePipelineImagesResponse
smart constructor.
Instances
newListImagePipelineImagesResponse Source #
Create a value of ListImagePipelineImagesResponse
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:imageSummaryList:ListImagePipelineImagesResponse'
, listImagePipelineImagesResponse_imageSummaryList
- The list of images built by this pipeline.
ListImagePipelineImages
, listImagePipelineImagesResponse_nextToken
- The next token used for paginated responses. When this is not empty,
there are additional elements that the service has not included in this
request. Use this token with the next request to retrieve additional
objects.
$sel:requestId:ListImagePipelineImagesResponse'
, listImagePipelineImagesResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:ListImagePipelineImagesResponse'
, listImagePipelineImagesResponse_httpStatus
- The response's http status code.
ListImagePipelines
data ListImagePipelines Source #
See: newListImagePipelines
smart constructor.
Instances
newListImagePipelines :: ListImagePipelines Source #
Create a value of ListImagePipelines
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:filters:ListImagePipelines'
, listImagePipelines_filters
- Use the following filters to streamline results:
description
distributionConfigurationArn
imageRecipeArn
infrastructureConfigurationArn
name
status
$sel:maxResults:ListImagePipelines'
, listImagePipelines_maxResults
- The maximum items to return in a request.
ListImagePipelines
, listImagePipelines_nextToken
- A token to specify where to start paginating. This is the NextToken from
a previously truncated response.
data ListImagePipelinesResponse Source #
See: newListImagePipelinesResponse
smart constructor.
Instances
newListImagePipelinesResponse Source #
Create a value of ListImagePipelinesResponse
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:imagePipelineList:ListImagePipelinesResponse'
, listImagePipelinesResponse_imagePipelineList
- The list of image pipelines.
ListImagePipelines
, listImagePipelinesResponse_nextToken
- The next token used for paginated responses. When this is not empty,
there are additional elements that the service has not included in this
request. Use this token with the next request to retrieve additional
objects.
$sel:requestId:ListImagePipelinesResponse'
, listImagePipelinesResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:ListImagePipelinesResponse'
, listImagePipelinesResponse_httpStatus
- The response's http status code.
ListImageRecipes
data ListImageRecipes Source #
See: newListImageRecipes
smart constructor.
Instances
newListImageRecipes :: ListImageRecipes Source #
Create a value of ListImageRecipes
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:filters:ListImageRecipes'
, listImageRecipes_filters
- Use the following filters to streamline results:
name
parentImage
platform
$sel:maxResults:ListImageRecipes'
, listImageRecipes_maxResults
- The maximum items to return in a request.
ListImageRecipes
, listImageRecipes_nextToken
- A token to specify where to start paginating. This is the NextToken from
a previously truncated response.
ListImageRecipes
, listImageRecipes_owner
- The owner defines which image recipes you want to list. By default, this
request will only show image recipes owned by your account. You can use
this field to specify if you want to view image recipes owned by
yourself, by Amazon, or those image recipes that have been shared with
you by other customers.
data ListImageRecipesResponse Source #
See: newListImageRecipesResponse
smart constructor.
Instances
newListImageRecipesResponse Source #
Create a value of ListImageRecipesResponse
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:imageRecipeSummaryList:ListImageRecipesResponse'
, listImageRecipesResponse_imageRecipeSummaryList
- The list of image pipelines.
ListImageRecipes
, listImageRecipesResponse_nextToken
- The next token used for paginated responses. When this is not empty,
there are additional elements that the service has not included in this
request. Use this token with the next request to retrieve additional
objects.
$sel:requestId:ListImageRecipesResponse'
, listImageRecipesResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:ListImageRecipesResponse'
, listImageRecipesResponse_httpStatus
- The response's http status code.
ListImages
data ListImages Source #
See: newListImages
smart constructor.
ListImages' (Maybe Bool) (Maybe (NonEmpty Filter)) (Maybe Bool) (Maybe Natural) (Maybe Text) (Maybe Ownership) |
Instances
newListImages :: ListImages Source #
Create a value of ListImages
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:byName:ListImages'
, listImages_byName
- Requests a list of images with a specific recipe name.
$sel:filters:ListImages'
, listImages_filters
- Use the following filters to streamline results:
name
osVersion
platform
type
version
$sel:includeDeprecated:ListImages'
, listImages_includeDeprecated
- Includes deprecated images in the response list.
$sel:maxResults:ListImages'
, listImages_maxResults
- The maximum items to return in a request.
ListImages
, listImages_nextToken
- A token to specify where to start paginating. This is the NextToken from
a previously truncated response.
ListImages
, listImages_owner
- The owner defines which images you want to list. By default, this
request will only show images owned by your account. You can use this
field to specify if you want to view images owned by yourself, by
Amazon, or those images that have been shared with you by other
customers.
data ListImagesResponse Source #
See: newListImagesResponse
smart constructor.
ListImagesResponse' (Maybe [ImageVersion]) (Maybe Text) (Maybe Text) Int |
Instances
newListImagesResponse Source #
Create a value of ListImagesResponse
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:imageVersionList:ListImagesResponse'
, listImagesResponse_imageVersionList
- The list of image semantic versions.
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.
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.
ListImages
, listImagesResponse_nextToken
- The next token used for paginated responses. When this is not empty,
there are additional elements that the service has not included in this
request. Use this token with the next request to retrieve additional
objects.
$sel:requestId:ListImagesResponse'
, listImagesResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:ListImagesResponse'
, listImagesResponse_httpStatus
- The response's http status code.
ListInfrastructureConfigurations
data ListInfrastructureConfigurations Source #
See: newListInfrastructureConfigurations
smart constructor.
Instances
newListInfrastructureConfigurations :: ListInfrastructureConfigurations Source #
Create a value of ListInfrastructureConfigurations
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:filters:ListInfrastructureConfigurations'
, listInfrastructureConfigurations_filters
- You can filter on name
to streamline results.
$sel:maxResults:ListInfrastructureConfigurations'
, listInfrastructureConfigurations_maxResults
- The maximum items to return in a request.
ListInfrastructureConfigurations
, listInfrastructureConfigurations_nextToken
- A token to specify where to start paginating. This is the NextToken from
a previously truncated response.
data ListInfrastructureConfigurationsResponse Source #
See: newListInfrastructureConfigurationsResponse
smart constructor.
ListInfrastructureConfigurationsResponse' (Maybe [InfrastructureConfigurationSummary]) (Maybe Text) (Maybe Text) Int |
Instances
newListInfrastructureConfigurationsResponse Source #
Create a value of ListInfrastructureConfigurationsResponse
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:infrastructureConfigurationSummaryList:ListInfrastructureConfigurationsResponse'
, listInfrastructureConfigurationsResponse_infrastructureConfigurationSummaryList
- The list of infrastructure configurations.
ListInfrastructureConfigurations
, listInfrastructureConfigurationsResponse_nextToken
- The next token used for paginated responses. When this is not empty,
there are additional elements that the service has not included in this
request. Use this token with the next request to retrieve additional
objects.
$sel:requestId:ListInfrastructureConfigurationsResponse'
, listInfrastructureConfigurationsResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:ListInfrastructureConfigurationsResponse'
, listInfrastructureConfigurationsResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
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:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- The Amazon Resource Name (ARN) of the resource whose tags you want to
retrieve.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
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:
ListTagsForResourceResponse
, listTagsForResourceResponse_tags
- The tags for the specified resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
PutComponentPolicy
data PutComponentPolicy Source #
See: newPutComponentPolicy
smart constructor.
Instances
newPutComponentPolicy Source #
Create a value of PutComponentPolicy
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:
PutComponentPolicy
, putComponentPolicy_componentArn
- The Amazon Resource Name (ARN) of the component that this policy should
be applied to.
$sel:policy:PutComponentPolicy'
, putComponentPolicy_policy
- The policy to apply.
data PutComponentPolicyResponse Source #
See: newPutComponentPolicyResponse
smart constructor.
Instances
newPutComponentPolicyResponse Source #
Create a value of PutComponentPolicyResponse
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:
PutComponentPolicy
, putComponentPolicyResponse_componentArn
- The Amazon Resource Name (ARN) of the component that this policy was
applied to.
$sel:requestId:PutComponentPolicyResponse'
, putComponentPolicyResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:PutComponentPolicyResponse'
, putComponentPolicyResponse_httpStatus
- The response's http status code.
PutContainerRecipePolicy
data PutContainerRecipePolicy Source #
See: newPutContainerRecipePolicy
smart constructor.
Instances
newPutContainerRecipePolicy Source #
:: Text | |
-> Text | |
-> PutContainerRecipePolicy |
Create a value of PutContainerRecipePolicy
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:
PutContainerRecipePolicy
, putContainerRecipePolicy_containerRecipeArn
- The Amazon Resource Name (ARN) of the container recipe that this policy
should be applied to.
$sel:policy:PutContainerRecipePolicy'
, putContainerRecipePolicy_policy
- The policy to apply to the container recipe.
data PutContainerRecipePolicyResponse Source #
See: newPutContainerRecipePolicyResponse
smart constructor.
Instances
newPutContainerRecipePolicyResponse Source #
Create a value of PutContainerRecipePolicyResponse
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:
PutContainerRecipePolicy
, putContainerRecipePolicyResponse_containerRecipeArn
- The Amazon Resource Name (ARN) of the container recipe that this policy
was applied to.
$sel:requestId:PutContainerRecipePolicyResponse'
, putContainerRecipePolicyResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:PutContainerRecipePolicyResponse'
, putContainerRecipePolicyResponse_httpStatus
- The response's http status code.
PutImagePolicy
data PutImagePolicy Source #
See: newPutImagePolicy
smart constructor.
Instances
Create a value of PutImagePolicy
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:
PutImagePolicy
, putImagePolicy_imageArn
- The Amazon Resource Name (ARN) of the image that this policy should be
applied to.
$sel:policy:PutImagePolicy'
, putImagePolicy_policy
- The policy to apply.
data PutImagePolicyResponse Source #
See: newPutImagePolicyResponse
smart constructor.
Instances
newPutImagePolicyResponse Source #
Create a value of PutImagePolicyResponse
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:
PutImagePolicy
, putImagePolicyResponse_imageArn
- The Amazon Resource Name (ARN) of the image that this policy was applied
to.
$sel:requestId:PutImagePolicyResponse'
, putImagePolicyResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:PutImagePolicyResponse'
, putImagePolicyResponse_httpStatus
- The response's http status code.
PutImageRecipePolicy
data PutImageRecipePolicy Source #
See: newPutImageRecipePolicy
smart constructor.
Instances
newPutImageRecipePolicy Source #
Create a value of PutImageRecipePolicy
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:
PutImageRecipePolicy
, putImageRecipePolicy_imageRecipeArn
- The Amazon Resource Name (ARN) of the image recipe that this policy
should be applied to.
$sel:policy:PutImageRecipePolicy'
, putImageRecipePolicy_policy
- The policy to apply.
data PutImageRecipePolicyResponse Source #
See: newPutImageRecipePolicyResponse
smart constructor.
Instances
newPutImageRecipePolicyResponse Source #
Create a value of PutImageRecipePolicyResponse
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:
PutImageRecipePolicy
, putImageRecipePolicyResponse_imageRecipeArn
- The Amazon Resource Name (ARN) of the image recipe that this policy was
applied to.
$sel:requestId:PutImageRecipePolicyResponse'
, putImageRecipePolicyResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:PutImageRecipePolicyResponse'
, putImageRecipePolicyResponse_httpStatus
- The response's http status code.
StartImagePipelineExecution
data StartImagePipelineExecution Source #
See: newStartImagePipelineExecution
smart constructor.
Instances
newStartImagePipelineExecution Source #
:: Text | |
-> Text | |
-> StartImagePipelineExecution |
Create a value of StartImagePipelineExecution
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:imagePipelineArn:StartImagePipelineExecution'
, startImagePipelineExecution_imagePipelineArn
- The Amazon Resource Name (ARN) of the image pipeline that you want to
manually invoke.
StartImagePipelineExecution
, startImagePipelineExecution_clientToken
- The idempotency token used to make this request idempotent.
data StartImagePipelineExecutionResponse Source #
See: newStartImagePipelineExecutionResponse
smart constructor.
Instances
newStartImagePipelineExecutionResponse Source #
Create a value of StartImagePipelineExecutionResponse
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:
StartImagePipelineExecution
, startImagePipelineExecutionResponse_clientToken
- The idempotency token used to make this request idempotent.
$sel:imageBuildVersionArn:StartImagePipelineExecutionResponse'
, startImagePipelineExecutionResponse_imageBuildVersionArn
- The Amazon Resource Name (ARN) of the image that was created by this
request.
$sel:requestId:StartImagePipelineExecutionResponse'
, startImagePipelineExecutionResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:StartImagePipelineExecutionResponse'
, startImagePipelineExecutionResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
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:resourceArn:TagResource'
, tagResource_resourceArn
- The Amazon Resource Name (ARN) of the resource that you want to tag.
TagResource
, tagResource_tags
- The tags to apply to the resource.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
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:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
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:resourceArn:UntagResource'
, untagResource_resourceArn
- The Amazon Resource Name (ARN) of the resource that you want to untag.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- The tag keys to remove from the resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
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:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
UpdateDistributionConfiguration
data UpdateDistributionConfiguration Source #
See: newUpdateDistributionConfiguration
smart constructor.
Instances
newUpdateDistributionConfiguration Source #
Create a value of UpdateDistributionConfiguration
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:
UpdateDistributionConfiguration
, updateDistributionConfiguration_description
- The description of the distribution configuration.
UpdateDistributionConfiguration
, updateDistributionConfiguration_distributionConfigurationArn
- The Amazon Resource Name (ARN) of the distribution configuration that
you want to update.
UpdateDistributionConfiguration
, updateDistributionConfiguration_distributions
- The distributions of the distribution configuration.
UpdateDistributionConfiguration
, updateDistributionConfiguration_clientToken
- The idempotency token of the distribution configuration.
data UpdateDistributionConfigurationResponse Source #
See: newUpdateDistributionConfigurationResponse
smart constructor.
Instances
newUpdateDistributionConfigurationResponse Source #
Create a value of UpdateDistributionConfigurationResponse
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:
UpdateDistributionConfiguration
, updateDistributionConfigurationResponse_clientToken
- The idempotency token used to make this request idempotent.
UpdateDistributionConfiguration
, updateDistributionConfigurationResponse_distributionConfigurationArn
- The Amazon Resource Name (ARN) of the distribution configuration that
was updated by this request.
$sel:requestId:UpdateDistributionConfigurationResponse'
, updateDistributionConfigurationResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:UpdateDistributionConfigurationResponse'
, updateDistributionConfigurationResponse_httpStatus
- The response's http status code.
UpdateImagePipeline
data UpdateImagePipeline Source #
See: newUpdateImagePipeline
smart constructor.
UpdateImagePipeline' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe ImageTestsConfiguration) (Maybe Schedule) (Maybe PipelineStatus) Text Text Text |
Instances
newUpdateImagePipeline Source #
:: Text | |
-> Text | |
-> Text | |
-> UpdateImagePipeline |
Create a value of UpdateImagePipeline
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:
UpdateImagePipeline
, updateImagePipeline_containerRecipeArn
- The Amazon Resource Name (ARN) of the container pipeline to update.
UpdateImagePipeline
, updateImagePipeline_description
- The description of the image pipeline.
UpdateImagePipeline
, updateImagePipeline_distributionConfigurationArn
- The Amazon Resource Name (ARN) of the distribution configuration that
will be used to configure and distribute images updated by this image
pipeline.
UpdateImagePipeline
, updateImagePipeline_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.
UpdateImagePipeline
, updateImagePipeline_imageRecipeArn
- The Amazon Resource Name (ARN) of the image recipe that will be used to
configure images updated by this image pipeline.
UpdateImagePipeline
, updateImagePipeline_imageTestsConfiguration
- The image test configuration of the image pipeline.
UpdateImagePipeline
, updateImagePipeline_schedule
- The schedule of the image pipeline.
UpdateImagePipeline
, updateImagePipeline_status
- The status of the image pipeline.
UpdateImagePipeline
, updateImagePipeline_imagePipelineArn
- The Amazon Resource Name (ARN) of the image pipeline that you want to
update.
UpdateImagePipeline
, updateImagePipeline_infrastructureConfigurationArn
- The Amazon Resource Name (ARN) of the infrastructure configuration that
will be used to build images updated by this image pipeline.
UpdateImagePipeline
, updateImagePipeline_clientToken
- The idempotency token used to make this request idempotent.
data UpdateImagePipelineResponse Source #
See: newUpdateImagePipelineResponse
smart constructor.
Instances
newUpdateImagePipelineResponse Source #
Create a value of UpdateImagePipelineResponse
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:
UpdateImagePipeline
, updateImagePipelineResponse_clientToken
- The idempotency token used to make this request idempotent.
UpdateImagePipeline
, updateImagePipelineResponse_imagePipelineArn
- The Amazon Resource Name (ARN) of the image pipeline that was updated by
this request.
$sel:requestId:UpdateImagePipelineResponse'
, updateImagePipelineResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:UpdateImagePipelineResponse'
, updateImagePipelineResponse_httpStatus
- The response's http status code.
UpdateInfrastructureConfiguration
data UpdateInfrastructureConfiguration Source #
See: newUpdateInfrastructureConfiguration
smart constructor.
UpdateInfrastructureConfiguration' (Maybe Text) (Maybe InstanceMetadataOptions) (Maybe [Text]) (Maybe Text) (Maybe Logging) (Maybe (HashMap Text Text)) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Bool) Text Text Text |
Instances
newUpdateInfrastructureConfiguration Source #
:: Text | |
-> Text | |
-> Text | |
-> UpdateInfrastructureConfiguration |
Create a value of UpdateInfrastructureConfiguration
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:
UpdateInfrastructureConfiguration
, updateInfrastructureConfiguration_description
- The description of the infrastructure configuration.
UpdateInfrastructureConfiguration
, updateInfrastructureConfiguration_instanceMetadataOptions
- The instance metadata options that you can set for the HTTP requests
that pipeline builds use to launch EC2 build and test instances. For
more information about instance metadata options, see one of the
following links:
- Configure the instance metadata options in the /Amazon EC2 User Guide/ for Linux instances.
- Configure the instance metadata options in the /Amazon EC2 Windows Guide/ for Windows instances.
UpdateInfrastructureConfiguration
, updateInfrastructureConfiguration_instanceTypes
- The instance types of the infrastructure configuration. You can specify
one or more instance types to use for this build. The service will pick
one of these instance types based on availability.
UpdateInfrastructureConfiguration
, updateInfrastructureConfiguration_keyPair
- The key pair of the infrastructure configuration. You can use this to
log on to and debug the instance used to create your image.
UpdateInfrastructureConfiguration
, updateInfrastructureConfiguration_logging
- The logging configuration of the infrastructure configuration.
UpdateInfrastructureConfiguration
, updateInfrastructureConfiguration_resourceTags
- The tags attached to the resource created by Image Builder.
UpdateInfrastructureConfiguration
, updateInfrastructureConfiguration_securityGroupIds
- The security group IDs to associate with the instance used to customize
your Amazon EC2 AMI.
UpdateInfrastructureConfiguration
, updateInfrastructureConfiguration_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.
UpdateInfrastructureConfiguration
, updateInfrastructureConfiguration_subnetId
- The subnet ID to place the instance used to customize your Amazon EC2
AMI in.
UpdateInfrastructureConfiguration
, updateInfrastructureConfiguration_terminateInstanceOnFailure
- The terminate instance on failure setting of the infrastructure
configuration. Set to false if you want Image Builder to retain the
instance used to configure your AMI if the build or test phase of your
workflow fails.
UpdateInfrastructureConfiguration
, updateInfrastructureConfiguration_infrastructureConfigurationArn
- The Amazon Resource Name (ARN) of the infrastructure configuration that
you want to update.
UpdateInfrastructureConfiguration
, updateInfrastructureConfiguration_instanceProfileName
- The instance profile to associate with the instance used to customize
your Amazon EC2 AMI.
UpdateInfrastructureConfiguration
, updateInfrastructureConfiguration_clientToken
- The idempotency token used to make this request idempotent.
data UpdateInfrastructureConfigurationResponse Source #
See: newUpdateInfrastructureConfigurationResponse
smart constructor.
Instances
newUpdateInfrastructureConfigurationResponse Source #
Create a value of UpdateInfrastructureConfigurationResponse
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:
UpdateInfrastructureConfiguration
, updateInfrastructureConfigurationResponse_clientToken
- The idempotency token used to make this request idempotent.
UpdateInfrastructureConfiguration
, updateInfrastructureConfigurationResponse_infrastructureConfigurationArn
- The Amazon Resource Name (ARN) of the infrastructure configuration that
was updated by this request.
$sel:requestId:UpdateInfrastructureConfigurationResponse'
, updateInfrastructureConfigurationResponse_requestId
- The request ID that uniquely identifies this request.
$sel:httpStatus:UpdateInfrastructureConfigurationResponse'
, updateInfrastructureConfigurationResponse_httpStatus
- The response's http status code.
Types
BuildType
pattern BuildType_IMPORT :: BuildType | |
pattern BuildType_SCHEDULED :: BuildType | |
pattern BuildType_USER_INITIATED :: BuildType |
Instances
ComponentFormat
newtype ComponentFormat Source #
pattern ComponentFormat_SHELL :: ComponentFormat |
Instances
ComponentStatus
newtype ComponentStatus Source #
pattern ComponentStatus_DEPRECATED :: ComponentStatus |
Instances
ComponentType
newtype ComponentType Source #
pattern ComponentType_BUILD :: ComponentType | |
pattern ComponentType_TEST :: ComponentType |
Instances
ContainerRepositoryService
newtype ContainerRepositoryService Source #
Instances
ContainerType
newtype ContainerType Source #
pattern ContainerType_DOCKER :: ContainerType |
Instances
DiskImageFormat
newtype DiskImageFormat Source #
pattern DiskImageFormat_RAW :: DiskImageFormat | |
pattern DiskImageFormat_VHD :: DiskImageFormat | |
pattern DiskImageFormat_VMDK :: DiskImageFormat |
Instances
EbsVolumeType
newtype EbsVolumeType Source #
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 #
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
pattern ImageType_AMI :: ImageType | |
pattern ImageType_DOCKER :: ImageType |
Instances
Ownership
pattern Ownership_Amazon :: Ownership | |
pattern Ownership_Self :: Ownership | |
pattern Ownership_Shared :: Ownership |
Instances
PipelineExecutionStartCondition
newtype PipelineExecutionStartCondition Source #
Instances
PipelineStatus
newtype PipelineStatus Source #
pattern PipelineStatus_DISABLED :: PipelineStatus | |
pattern PipelineStatus_ENABLED :: PipelineStatus |
Instances
Platform
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.
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
Ami
Details of an Amazon EC2 AMI.
See: newAmi
smart constructor.
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.
AmiDistributionConfiguration
data AmiDistributionConfiguration Source #
Define and configure the output AMIs of the pipeline.
See: newAmiDistributionConfiguration
smart constructor.
AmiDistributionConfiguration' (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe LaunchPermissionConfiguration) (Maybe Text) (Maybe (NonEmpty Text)) |
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.
Component
A detailed view of a component.
See: newComponent
smart constructor.
Component' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [ComponentParameterDetail]) (Maybe Platform) (Maybe ComponentState) (Maybe (NonEmpty Text)) (Maybe (HashMap Text Text)) (Maybe ComponentType) (Maybe Text) |
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.
ComponentConfiguration
data ComponentConfiguration Source #
Configuration details of the component.
See: newComponentConfiguration
smart constructor.
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.
ComponentParameter
data ComponentParameter Source #
Contains a key/value pair that sets the named component parameter.
See: newComponentParameter
smart constructor.
Instances
newComponentParameter Source #
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.
ComponentParameterDetail
data ComponentParameterDetail Source #
Defines a parameter that is used to provide configuration details for the component.
See: newComponentParameterDetail
smart constructor.
Instances
newComponentParameterDetail Source #
:: 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".
ComponentState
data ComponentState Source #
A group of fields that describe the current status of components that are no longer active.
See: newComponentState
smart constructor.
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.
ComponentSummary
data ComponentSummary Source #
A high-level summary of a component.
See: newComponentSummary
smart constructor.
ComponentSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Platform) (Maybe ComponentState) (Maybe (NonEmpty Text)) (Maybe (HashMap Text Text)) (Maybe ComponentType) (Maybe Text) |
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.
ComponentVersion
data ComponentVersion Source #
The defining characteristics of a specific version of an Amazon Web Services TOE component.
See: newComponentVersion
smart constructor.
ComponentVersion' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Platform) (Maybe (NonEmpty Text)) (Maybe ComponentType) (Maybe Text) |
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.
Container
A container encapsulates the runtime environment for an application.
See: newContainer
smart constructor.
Container' (Maybe [Text]) (Maybe Text) |
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.
ContainerDistributionConfiguration
data ContainerDistributionConfiguration Source #
Container distribution settings for encryption, licensing, and sharing in a specific Region.
See: newContainerDistributionConfiguration
smart constructor.
Instances
newContainerDistributionConfiguration Source #
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.
ContainerRecipe
data ContainerRecipe Source #
A container recipe.
See: newContainerRecipe
smart constructor.
ContainerRecipe' (Maybe Text) (Maybe (NonEmpty ComponentConfiguration)) (Maybe ContainerType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe InstanceConfiguration) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Platform) (Maybe (HashMap Text Text)) (Maybe TargetContainerRepository) (Maybe Text) (Maybe Text) |
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.
ContainerRecipeSummary
data ContainerRecipeSummary Source #
A summary of a container recipe
See: newContainerRecipeSummary
smart constructor.
ContainerRecipeSummary' (Maybe Text) (Maybe ContainerType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Platform) (Maybe (HashMap Text Text)) |
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.
Distribution
data Distribution Source #
Defines the settings for a specific Region.
See: newDistribution
smart constructor.
Instances
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.
DistributionConfiguration
data DistributionConfiguration Source #
A distribution configuration.
See: newDistributionConfiguration
smart constructor.
DistributionConfiguration' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Distribution]) (Maybe Text) (Maybe (HashMap Text Text)) Natural |
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.
DistributionConfigurationSummary
data DistributionConfigurationSummary Source #
A high-level overview of a distribution configuration.
See: newDistributionConfigurationSummary
smart constructor.
DistributionConfigurationSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe (HashMap Text Text)) |
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.
EbsInstanceBlockDeviceSpecification
data EbsInstanceBlockDeviceSpecification Source #
Amazon EBS-specific block device mapping specifications.
See: newEbsInstanceBlockDeviceSpecification
smart constructor.
EbsInstanceBlockDeviceSpecification' (Maybe Bool) (Maybe Bool) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe EbsVolumeType) |
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.
FastLaunchConfiguration
data FastLaunchConfiguration Source #
Define and configure faster launching for output Windows AMIs.
See: newFastLaunchConfiguration
smart constructor.
FastLaunchConfiguration' (Maybe Text) (Maybe FastLaunchLaunchTemplateSpecification) (Maybe Natural) (Maybe FastLaunchSnapshotConfiguration) Bool |
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.
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.
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.
FastLaunchSnapshotConfiguration
data FastLaunchSnapshotConfiguration Source #
Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.
See: newFastLaunchSnapshotConfiguration
smart constructor.
Instances
FromJSON FastLaunchSnapshotConfiguration Source # | |
ToJSON FastLaunchSnapshotConfiguration Source # | |
Generic FastLaunchSnapshotConfiguration Source # | |
Read FastLaunchSnapshotConfiguration Source # | |
Show FastLaunchSnapshotConfiguration Source # | |
NFData FastLaunchSnapshotConfiguration Source # | |
Eq FastLaunchSnapshotConfiguration Source # | |
Hashable FastLaunchSnapshotConfiguration Source # | |
type Rep FastLaunchSnapshotConfiguration Source # | |
Defined in Amazonka.ImageBuilder.Types.FastLaunchSnapshotConfiguration type Rep FastLaunchSnapshotConfiguration = D1 ('MetaData "FastLaunchSnapshotConfiguration" "Amazonka.ImageBuilder.Types.FastLaunchSnapshotConfiguration" "amazonka-imagebuilder-2.0-BBLLjX59RW72O8VbQ3vKvH" 'False) (C1 ('MetaCons "FastLaunchSnapshotConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "targetResourceCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) |
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.
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.
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.
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.
Image' (Maybe Text) (Maybe BuildType) (Maybe ContainerRecipe) (Maybe Text) (Maybe DistributionConfiguration) (Maybe Bool) (Maybe ImageRecipe) (Maybe ImageTestsConfiguration) (Maybe InfrastructureConfiguration) (Maybe Text) (Maybe Text) (Maybe OutputResources) (Maybe Platform) (Maybe Text) (Maybe Text) (Maybe ImageState) (Maybe (HashMap Text Text)) (Maybe ImageType) (Maybe Text) |
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.
ImagePackage
data ImagePackage Source #
Represents a package installed on an Image Builder image.
See: newImagePackage
smart constructor.
ImagePackage' (Maybe Text) (Maybe Text) |
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.
ImagePipeline
data ImagePipeline Source #
Details of an image pipeline.
See: newImagePipeline
smart constructor.
ImagePipeline' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe ImageTestsConfiguration) (Maybe Text) (Maybe Text) (Maybe Platform) (Maybe Schedule) (Maybe PipelineStatus) (Maybe (HashMap Text Text)) |
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.
ImageRecipe
data ImageRecipe Source #
An image recipe.
See: newImageRecipe
smart constructor.
ImageRecipe' (Maybe AdditionalInstanceConfiguration) (Maybe Text) (Maybe [InstanceBlockDeviceMapping]) (Maybe (NonEmpty ComponentConfiguration)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Platform) (Maybe (HashMap Text Text)) (Maybe ImageType) (Maybe Text) (Maybe Text) |
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.
ImageRecipeSummary
data ImageRecipeSummary Source #
A summary of an image recipe.
See: newImageRecipeSummary
smart constructor.
ImageRecipeSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Platform) (Maybe (HashMap Text Text)) |
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.
ImageState
data ImageState Source #
Image state shows the image status and the reason for that status.
See: newImageState
smart constructor.
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.
ImageSummary
data ImageSummary Source #
An image summary.
See: newImageSummary
smart constructor.
ImageSummary' (Maybe Text) (Maybe BuildType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe OutputResources) (Maybe Text) (Maybe Platform) (Maybe ImageState) (Maybe (HashMap Text Text)) (Maybe ImageType) (Maybe Text) |
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.
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.
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.
ImageVersion
data ImageVersion Source #
The defining characteristics of a specific version of an Image Builder image.
See: newImageVersion
smart constructor.
ImageVersion' (Maybe Text) (Maybe BuildType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Platform) (Maybe ImageType) (Maybe Text) |
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.
InfrastructureConfiguration
data InfrastructureConfiguration Source #
Details of the infrastructure configuration.
See: newInfrastructureConfiguration
smart constructor.
InfrastructureConfiguration' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InstanceMetadataOptions) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Logging) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Bool) |
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.
InfrastructureConfigurationSummary
data InfrastructureConfigurationSummary Source #
The infrastructure used when building Amazon EC2 AMIs.
See: newInfrastructureConfigurationSummary
smart constructor.
InfrastructureConfigurationSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) |
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.
InstanceBlockDeviceMapping
data InstanceBlockDeviceMapping Source #
Defines block device mappings for the instance used to configure your image.
See: newInstanceBlockDeviceMapping
smart constructor.
InstanceBlockDeviceMapping' (Maybe Text) (Maybe EbsInstanceBlockDeviceSpecification) (Maybe Text) (Maybe Text) |
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.
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.
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.
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.
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.
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.
LaunchPermissionConfiguration' (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe [Text]) (Maybe (NonEmpty Text)) |
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.
LaunchTemplateConfiguration
data LaunchTemplateConfiguration Source #
Identifies an Amazon EC2 launch template to use for a specific account.
See: newLaunchTemplateConfiguration
smart constructor.
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.
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.
OutputResources' (Maybe [Ami]) (Maybe [Container]) |
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.
S3ExportConfiguration
data S3ExportConfiguration Source #
Properties that configure export from your build instance to a compatible file format for your VM.
See: newS3ExportConfiguration
smart constructor.
Instances
newS3ExportConfiguration Source #
:: 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.
S3Logs
Amazon S3 logging configuration.
See: newS3Logs
smart constructor.
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.
Schedule
A schedule configures how often and when a pipeline will automatically create a new image.
See: newSchedule
smart constructor.
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.
SystemsManagerAgent
data SystemsManagerAgent Source #
Contains settings for the Systems Manager agent on your build instance.
See: newSystemsManagerAgent
smart constructor.
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.
TargetContainerRepository
data TargetContainerRepository Source #
The container repository where the output container image is stored.
See: newTargetContainerRepository
smart constructor.
Instances
newTargetContainerRepository Source #
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.