Package software.amazon.awssdk.services.imagebuilder.model

Class CreateImageRequest

    • Method Detail

      • imageRecipeArn

        public final String imageRecipeArn()

        The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

        Returns:
        The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

      • containerRecipeArn

        public final String containerRecipeArn()

        The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.

        Returns:
        The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.

      • distributionConfigurationArn

        public final String distributionConfigurationArn()

        The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.

        Returns:
        The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.

      • infrastructureConfigurationArn

        public final String infrastructureConfigurationArn()

        The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.

        Returns:
        The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.

      • imageTestsConfiguration

        public final ImageTestsConfiguration imageTestsConfiguration()

        The image tests configuration of the image.

        Returns:
        The image tests configuration of the image.

      • enhancedImageMetadataEnabled

        public final Boolean 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.

        Returns:
        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.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final Map<String,​String> tags()

        The tags of the image.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        The tags of the image.

      • clientToken

        public final String 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.

        Returns:
        Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      • imageScanningConfiguration

        public final ImageScanningConfiguration imageScanningConfiguration()

        Contains settings for vulnerability scans.

        Returns:
        Contains settings for vulnerability scans.

      • hasWorkflows

        public final boolean hasWorkflows()
        For responses, this returns true if the service returned a value for the Workflows property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • workflows

        public final List<WorkflowConfiguration> workflows()

        Contains an array of workflow configuration objects.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasWorkflows() method.

        Returns:
        Contains an array of workflow configuration objects.

      • executionRole

        public final String executionRole()

        The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

        Returns:
        The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object