software.amazon.awscdk.services.imagebuilder

Class CfnComponent.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnComponent>

Enclosing class:

CfnComponent

@Stability(value=Stable)
public static final class CfnComponent.Builder
extends Object
implements software.amazon.jsii.Builder<CfnComponent>

A fluent builder for CfnComponent.

Method Summary

Modifier and Type	Method and Description
CfnComponent	build()
CfnComponent.Builder	changeDescription(String changeDescription) A change description of the component.
static CfnComponent.Builder	create(software.constructs.Construct scope, String id)
CfnComponent.Builder	data(String data) The data of the component.
CfnComponent.Builder	description(String description) The description of the component.
CfnComponent.Builder	kmsKeyId(String kmsKeyId) The KMS key identifier used to encrypt the component.
CfnComponent.Builder	name(String name) The name of the component.
CfnComponent.Builder	platform(String platform) The platform of the component.
CfnComponent.Builder	supportedOsVersions(List<String> supportedOsVersions) The operating system (OS) version supported by the component.
CfnComponent.Builder	tags(Map<String,String> tags) The tags associated with the component.
CfnComponent.Builder	uri(String uri) The `uri` of a YAML component document file.
CfnComponent.Builder	version(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

@Stability(value=Stable)
public static CfnComponent.Builder create(software.constructs.Construct scope,
                                                                   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

@Stability(value=Stable)
public CfnComponent.Builder name(String name)

The name of the component.

Parameters:

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

Returns:

this

platform

@Stability(value=Stable)
public CfnComponent.Builder platform(String platform)

The platform of the component.

For example, Windows .

Parameters:

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

Returns:

this

version

@Stability(value=Stable)
public CfnComponent.Builder version(String version)

The component version.

For example, 1.0.0 .

Parameters:

version - The component version. This parameter is required.

Returns:

this

changeDescription

@Stability(value=Stable)
public CfnComponent.Builder changeDescription(String changeDescription)

A change description of the component.

For example initial version .

Parameters:

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

Returns:

this

data

@Stability(value=Stable)
public CfnComponent.Builder data(String data)

The data of the component.

For example, name: HelloWorldTestingDocument\ndescription: This is hello world testing document.\nschemaVersion: 1.0\n\nphases:\n - name: test\n steps:\n - name: HelloWorldStep\n action: ExecuteBash\n inputs:\n commands:\n - echo \"Hello World! Test.\"\n . See Examples below for the schema for creating a component using Data.

Parameters:

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

Returns:

this

description

@Stability(value=Stable)
public CfnComponent.Builder description(String description)

The description of the component.

Parameters:

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

Returns:

this

kmsKeyId

@Stability(value=Stable)
public CfnComponent.Builder kmsKeyId(String kmsKeyId)

The KMS key identifier used to encrypt the component.

Parameters:

kmsKeyId - The KMS key identifier used to encrypt the component. This parameter is required.

Returns:

this

supportedOsVersions

@Stability(value=Stable)
public CfnComponent.Builder supportedOsVersions(List<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

@Stability(value=Stable)
public CfnComponent.Builder tags(Map<String,String> tags)

The tags associated with the component.

Parameters:

tags - The tags associated with the component. This parameter is required.

Returns:

this

uri

@Stability(value=Stable)
public CfnComponent.Builder uri(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

@Stability(value=Stable)
public CfnComponent build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnComponent>