@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
date="2022-05-27T16:27:55.472Z")
public interface CfnComponentProps
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.imagebuilder.*; CfnComponentProps cfnComponentProps = CfnComponentProps.builder() .name("name") .platform("platform") .version("version") // the properties below are optional .changeDescription("changeDescription") .data("data") .description("description") .kmsKeyId("kmsKeyId") .supportedOsVersions(List.of("supportedOsVersions")) .tags(Map.of( "tagsKey", "tags")) .uri("uri") .build();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnComponentProps.Builder
A builder for
CfnComponentProps |
static class |
CfnComponentProps.Jsii$Proxy
An implementation for
CfnComponentProps |
Modifier and Type | Method and Description |
---|---|
static CfnComponentProps.Builder |
builder() |
default java.lang.String |
getChangeDescription()
The change description of the component.
|
default java.lang.String |
getData()
Component `data` contains inline YAML document content for the component.
|
default java.lang.String |
getDescription()
The description of the component.
|
default java.lang.String |
getKmsKeyId()
The ID of the KMS key that should be used to encrypt this component.
|
java.lang.String |
getName()
The name of the component.
|
java.lang.String |
getPlatform()
The platform of the component.
|
default java.util.List<java.lang.String> |
getSupportedOsVersions()
The operating system (OS) version supported by the component.
|
default java.util.Map<java.lang.String,java.lang.String> |
getTags()
The tags of the component.
|
default java.lang.String |
getUri()
The `uri` of a YAML component document file.
|
java.lang.String |
getVersion()
The component version.
|
java.lang.String getName()
java.lang.String getPlatform()
java.lang.String getVersion()
For example, 1.0.0
.
default java.lang.String getChangeDescription()
Describes what change has been made in this version, or what makes this version different from other versions of this component.
default java.lang.String getData()
Alternatively, you can specify the uri
of a YAML document file stored in Amazon S3. However, you cannot specify both properties.
default java.lang.String getDescription()
Describes the contents of the component.
default java.lang.String getKmsKeyId()
default java.util.List<java.lang.String> getSupportedOsVersions()
If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.
default java.util.Map<java.lang.String,java.lang.String> getTags()
default java.lang.String getUri()
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.
static CfnComponentProps.Builder builder()
CfnComponentProps.Builder
of CfnComponentProps