ContainerRecipe (AWS Java SDK :: Services :: Imagebuilder 2.16.45 API)

java.lang.Object
- software.amazon.awssdk.services.imagebuilder.model.ContainerRecipe

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ContainerRecipe.Builder,ContainerRecipe>

@Generated(value="software.amazon.awssdk:codegen")
public final class ContainerRecipe
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ContainerRecipe.Builder,ContainerRecipe>

A container recipe.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ContainerRecipe.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ContainerRecipe.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The Amazon Resource Name (ARN) of the container recipe.
`static ContainerRecipe.Builder`	`builder()`
`List<ComponentConfiguration>`	`components()` Components for build and test that are included in the container recipe.
`ContainerType`	`containerType()` Specifies the type of container, such as Docker.
`String`	`containerTypeAsString()` Specifies the type of container, such as Docker.
`String`	`dateCreated()` The date when this container recipe was created.
`String`	`description()` The description of the container recipe.
`String`	`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.
`Boolean`	`encrypted()` A flag that indicates if the target container is encrypted.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasComponents()` Returns true if the Components property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`InstanceConfiguration`	`instanceConfiguration()` A group of options that can be used to configure an instance for building and testing container images.
`String`	`kmsKeyId()` Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
`String`	`name()` The name of the container recipe.
`String`	`owner()` The owner of the container recipe.
`String`	`parentImage()` The source image for the container recipe.
`Platform`	`platform()` The system platform for the container, such as Windows or Linux.
`String`	`platformAsString()` The system platform for the container, such as Windows or Linux.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ContainerRecipe.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()` Tags that are attached to the container recipe.
`TargetContainerRepository`	`targetRepository()` The destination repository for the container image.
`ContainerRecipe.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`version()` The semantic version of the container recipe (<major>.<minor>.<patch>).
`String`	`workingDirectory()` The working directory for use during build and test workflows.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the container recipe.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the container recipe.
  - containerType
```
public final ContainerType containerType()
```
    Specifies the type of container, such as Docker.
    
    If the service returns an enum value that is not available in the current SDK version, containerType will return ContainerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from containerTypeAsString().
    
    Returns:
    
    Specifies the type of container, such as Docker.
    
    See Also:
    
    ContainerType
  - containerTypeAsString
```
public final String containerTypeAsString()
```
    Specifies the type of container, such as Docker.
    
    If the service returns an enum value that is not available in the current SDK version, containerType will return ContainerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from containerTypeAsString().
    
    Returns:
    
    Specifies the type of container, such as Docker.
    
    See Also:
    
    ContainerType
  - name
```
public final String name()
```
    The name of the container recipe.
    
    Returns:
    
    The name of the container recipe.
  - description
```
public final String description()
```
    The description of the container recipe.
    
    Returns:
    
    The description of the container recipe.
  - platform
```
public final Platform platform()
```
    The system platform for the container, such as Windows or Linux.
    
    If the service returns an enum value that is not available in the current SDK version, platform will return Platform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().
    
    Returns:
    
    The system platform for the container, such as Windows or Linux.
    
    See Also:
    
    Platform
  - platformAsString
```
public final String platformAsString()
```
    The system platform for the container, such as Windows or Linux.
    
    If the service returns an enum value that is not available in the current SDK version, platform will return Platform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().
    
    Returns:
    
    The system platform for the container, such as Windows or Linux.
    
    See Also:
    
    Platform
  - owner
```
public final String owner()
```
    The owner of the container recipe.
    
    Returns:
    
    The owner of the container recipe.
  - version
```
public final String version()
```
    The semantic version of the container recipe (<major>.<minor>.<patch>).
    
    Returns:
    
    The semantic version of the container recipe (<major>.<minor>.<patch>).
  - hasComponents
```
public final boolean hasComponents()
```
    Returns true if the Components property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - components
```
public final List<ComponentConfiguration> components()
```
    Components for build and test that are included in the container recipe.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasComponents() to see if a value was sent in this field.
    
    Returns:
    
    Components for build and test that are included in the container recipe.
  - instanceConfiguration
```
public final InstanceConfiguration instanceConfiguration()
```
    A group of options that can be used to configure an instance for building and testing container images.
    
    Returns:
    
    A group of options that can be used to configure an instance for building and testing container images.
  - dockerfileTemplateData
```
public final String 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.
    
    Returns:
    
    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.
  - kmsKeyId
```
public final String kmsKeyId()
```
    Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
    
    Returns:
    
    Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
  - encrypted
```
public final Boolean encrypted()
```
    A flag that indicates if the target container is encrypted.
    
    Returns:
    
    A flag that indicates if the target container is encrypted.
  - parentImage
```
public final String parentImage()
```
    The source image for the container recipe.
    
    Returns:
    
    The source image for the container recipe.
  - dateCreated
```
public final String dateCreated()
```
    The date when this container recipe was created.
    
    Returns:
    
    The date when this container recipe was created.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final Map<String,String> tags()
```
    Tags that are attached to the container recipe.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    Tags that are attached to the container recipe.
  - workingDirectory
```
public final String workingDirectory()
```
    The working directory for use during build and test workflows.
    
    Returns:
    
    The working directory for use during build and test workflows.
  - targetRepository
```
public final TargetContainerRepository targetRepository()
```
    The destination repository for the container image.
    
    Returns:
    
    The destination repository for the container image.
  - toBuilder
```
public ContainerRecipe.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ContainerRecipe.Builder,ContainerRecipe>
  - builder
```
public static ContainerRecipe.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ContainerRecipe.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ContainerRecipe

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

arn

containerType

containerTypeAsString

name

description

platform

platformAsString

owner

version

hasComponents

components

instanceConfiguration

dockerfileTemplateData

kmsKeyId

encrypted

parentImage

dateCreated

hasTags

tags

workingDirectory

targetRepository

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields