software.amazon.awscdk.services.imagebuilder

Class CfnComponentProps.Builder

java.lang.Object

software.amazon.awscdk.services.imagebuilder.CfnComponentProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnComponentProps>

Enclosing interface:

CfnComponentProps

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

A builder for CfnComponentProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnComponentProps	build() Builds the configured instance.
CfnComponentProps.Builder	changeDescription(String changeDescription) Sets the value of CfnComponentProps.getChangeDescription()
CfnComponentProps.Builder	data(String data) Sets the value of CfnComponentProps.getData()
CfnComponentProps.Builder	description(String description) Sets the value of CfnComponentProps.getDescription()
CfnComponentProps.Builder	kmsKeyId(String kmsKeyId) Sets the value of CfnComponentProps.getKmsKeyId()
CfnComponentProps.Builder	name(String name) Sets the value of CfnComponentProps.getName()
CfnComponentProps.Builder	platform(String platform) Sets the value of CfnComponentProps.getPlatform()
CfnComponentProps.Builder	supportedOsVersions(List<String> supportedOsVersions) Sets the value of CfnComponentProps.getSupportedOsVersions()
CfnComponentProps.Builder	tags(Map<String,String> tags) Sets the value of CfnComponentProps.getTags()
CfnComponentProps.Builder	uri(String uri) Sets the value of CfnComponentProps.getUri()
CfnComponentProps.Builder	version(String version) Sets the value of CfnComponentProps.getVersion()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

name

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

Sets the value of CfnComponentProps.getName()

Parameters:

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

Returns:

this

platform

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

Sets the value of CfnComponentProps.getPlatform()

Parameters:

platform - The platform of the component. This parameter is required. For example, Windows .

Returns:

this

version

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

Sets the value of CfnComponentProps.getVersion()

Parameters:

version - The component version. This parameter is required. For example, 1.0.0 .

Returns:

this

changeDescription

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

Sets the value of CfnComponentProps.getChangeDescription()

Parameters:

changeDescription - A change description of the component. For example initial version .

Returns:

this

data

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

Sets the value of CfnComponentProps.getData()

Parameters:

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.

Returns:

this

description

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

Sets the value of CfnComponentProps.getDescription()

Parameters:

description - The description of the component.

Returns:

this

kmsKeyId

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

Sets the value of CfnComponentProps.getKmsKeyId()

Parameters:

kmsKeyId - The KMS key identifier used to encrypt the component.

Returns:

this

supportedOsVersions

@Stability(value=Stable)
public CfnComponentProps.Builder supportedOsVersions(List<String> supportedOsVersions)

Sets the value of CfnComponentProps.getSupportedOsVersions()

Parameters:

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.

Returns:

this

tags

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

Sets the value of CfnComponentProps.getTags()

Parameters:

tags - The tags associated with the component.

Returns:

this

uri

@Stability(value=Stable)
public CfnComponentProps.Builder uri(String uri)

Sets the value of CfnComponentProps.getUri()

Parameters:

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.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnComponentProps

Throws:

NullPointerException - if any required attribute was not provided