software.amazon.awscdk.services.imagebuilder

Class CfnComponent.Builder

java.lang.Object

software.amazon.awscdk.services.imagebuilder.CfnComponent.Builder

Enclosing class:

CfnComponent

public static final class CfnComponent.Builder
extends java.lang.Object

A fluent builder for CfnComponent.

Method Summary

Modifier and Type	Method and Description
CfnComponent	build()
CfnComponent.Builder	changeDescription(java.lang.String changeDescription) The change description of the component.
static CfnComponent.Builder	create(Construct scope, java.lang.String id)
CfnComponent.Builder	data(java.lang.String data) Component `data` contains inline YAML document content for the component.
CfnComponent.Builder	description(java.lang.String description) Describes the contents of the component.
CfnComponent.Builder	kmsKeyId(java.lang.String kmsKeyId) The ID of the KMS key that is used to encrypt this component.
CfnComponent.Builder	name(java.lang.String name) The name of the component.
CfnComponent.Builder	platform(java.lang.String platform) The operating system platform of the component.
CfnComponent.Builder	supportedOsVersions(java.util.List<java.lang.String> supportedOsVersions) The operating system (OS) version supported by the component.
CfnComponent.Builder	tags(java.util.Map<java.lang.String,java.lang.String> tags) The tags that apply to the component.
CfnComponent.Builder	uri(java.lang.String uri) The `uri` of a YAML component document file.
CfnComponent.Builder	version(java.lang.String version) The component version.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static CfnComponent.Builder create(Construct scope,
                                          java.lang.String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnComponent.Builder.

name

public CfnComponent.Builder name(java.lang.String name)

The name of the component.

Parameters:

name - The name of the component. This parameter is required.

Returns:

this

platform

public CfnComponent.Builder platform(java.lang.String platform)

The operating system platform of the component.

Parameters:

platform - The operating system platform of the component. This parameter is required.

Returns:

this

version

public CfnComponent.Builder version(java.lang.String version)

The component version.

For example, 1.0.0 .

Parameters:

version - The component version. This parameter is required.

Returns:

this

changeDescription

public CfnComponent.Builder changeDescription(java.lang.String 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.

Parameters:

changeDescription - The change description of the component. This parameter is required.

Returns:

this

data

public CfnComponent.Builder data(java.lang.String 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.

Parameters:

data - Component `data` contains inline YAML document content for the component. This parameter is required.

Returns:

this

description

public CfnComponent.Builder description(java.lang.String description)

Describes the contents of the component.

Parameters:

description - Describes the contents of the component. This parameter is required.

Returns:

this

kmsKeyId

public CfnComponent.Builder kmsKeyId(java.lang.String kmsKeyId)

The ID of the KMS key that is used to encrypt this component.

Parameters:

kmsKeyId - The ID of the KMS key that is used to encrypt this component. This parameter is required.

Returns:

this

supportedOsVersions

public CfnComponent.Builder supportedOsVersions(java.util.List<java.lang.String> 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.

Parameters:

supportedOsVersions - The operating system (OS) version supported by the component. This parameter is required.

Returns:

this

tags

public CfnComponent.Builder tags(java.util.Map<java.lang.String,java.lang.String> tags)

The tags that apply to the component.

Parameters:

tags - The tags that apply to the component. This parameter is required.

Returns:

this

uri

public CfnComponent.Builder uri(java.lang.String 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.

Parameters:

uri - The `uri` of a YAML component document file. This parameter is required.

Returns:

this

build

public CfnComponent build()