Package 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(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	Description
CfnComponent	build()
CfnComponent.Builder	changeDescription(String changeDescription)	The change description of the component.
static CfnComponent.Builder	create(software.constructs.Construct scope, String id)
CfnComponent.Builder	data(String data)	Component data contains inline YAML document content for the component.
CfnComponent.Builder	description(String description)	Describes the contents of the component.
CfnComponent.Builder	kmsKeyId(String kmsKeyId)	The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this component.
CfnComponent.Builder	name(String name)	The name of the component.
CfnComponent.Builder	platform(String platform)	The operating system 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 that apply to the component.
CfnComponent.Builder	uri(String uri)	The uri of a YAML component document file.
CfnComponent.Builder	version(String version)	The semantic version of the component.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(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 - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnComponent.Builder.

name

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-name

platform

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

The operating system platform of the component.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-platform

version

@Stability(Stable)
public CfnComponent.Builder version(String 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.

Parameters:

version - The semantic version of the component. This version follows the semantic version syntax. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-version

changeDescription

@Stability(Stable)
public CfnComponent.Builder changeDescription(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 the component.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-changedescription

data

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-data

description

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

Describes the contents of the component.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-description

kmsKeyId

@Stability(Stable)
public CfnComponent.Builder kmsKeyId(String 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 .

Parameters:

kmsKeyId - The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this component. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-kmskeyid

supportedOsVersions

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-supportedosversions

tags

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

The tags that apply to the component.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-tags

uri

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-uri

build

@Stability(Stable)
public CfnComponent build()

Specified by:

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

Returns:

a newly built instance of CfnComponent.