Package software.amazon.awscdk.cfnpropertymixins.services.imagebuilder

Class CfnComponentMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.imagebuilder.CfnComponentMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnComponentMixinProps>

Enclosing interface:

CfnComponentMixinProps

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

A builder for CfnComponentMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

changeDescription

@Stability(Stable)
public CfnComponentMixinProps.Builder changeDescription(String changeDescription)

Sets the value of CfnComponentMixinProps.getChangeDescription()

Parameters:

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 the component.

Returns:

this

data

@Stability(Stable)
public CfnComponentMixinProps.Builder data(String data)

Sets the value of CfnComponentMixinProps.getData()

Parameters:

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.

Returns:

this

description

@Stability(Stable)
public CfnComponentMixinProps.Builder description(String description)

Sets the value of CfnComponentMixinProps.getDescription()

Parameters:

description - Describes the contents of the component.

Returns:

this

kmsKeyId

@Stability(Stable)
public CfnComponentMixinProps.Builder kmsKeyId(String kmsKeyId)

Sets the value of CfnComponentMixinProps.getKmsKeyId()

Parameters:

kmsKeyId - The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this component. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .

Returns:

this

name

@Stability(Stable)
public CfnComponentMixinProps.Builder name(String name)

Sets the value of CfnComponentMixinProps.getName()

Parameters:

name - The name of the component.

Returns:

this

platform

@Stability(Stable)
public CfnComponentMixinProps.Builder platform(String platform)

Sets the value of CfnComponentMixinProps.getPlatform()

Parameters:

platform - The operating system platform of the component.

Returns:

this

supportedOsVersions

@Stability(Stable)
public CfnComponentMixinProps.Builder supportedOsVersions(List<String> supportedOsVersions)

Sets the value of CfnComponentMixinProps.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(Stable)
public CfnComponentMixinProps.Builder tags(Map<String,String> tags)

Sets the value of CfnComponentMixinProps.getTags()

Parameters:

tags - The tags that apply to the component.

Returns:

this

uri

@Stability(Stable)
public CfnComponentMixinProps.Builder uri(String uri)

Sets the value of CfnComponentMixinProps.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

version

@Stability(Stable)
public CfnComponentMixinProps.Builder version(String version)

Sets the value of CfnComponentMixinProps.getVersion()

Parameters:

version - The semantic version of the component. This version follows the semantic version syntax.

The semantic version has four nodes: ../. You can assign values for the first three, and can filter on all of them.

Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

Returns:

this

build

@Stability(Stable)
public CfnComponentMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnComponentMixinProps

Throws:

NullPointerException - if any required attribute was not provided