Package software.amazon.awscdk.services.proton

Interface CfnEnvironmentTemplateProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEnvironmentTemplateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-10-14T12:28:16.798Z")
@Stability(Stable)
public interface CfnEnvironmentTemplateProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnEnvironmentTemplate.

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.proton.*;
 CfnEnvironmentTemplateProps cfnEnvironmentTemplateProps = CfnEnvironmentTemplateProps.builder()
         .description("description")
         .displayName("displayName")
         .encryptionKey("encryptionKey")
         .name("name")
         .provisioning("provisioning")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmenttemplate.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEnvironmentTemplateProps.Builder	A builder for CfnEnvironmentTemplateProps
static final class	CfnEnvironmentTemplateProps.Jsii$Proxy	An implementation for CfnEnvironmentTemplateProps

Method Summary

Modifier and Type	Method	Description
static CfnEnvironmentTemplateProps.Builder	builder()
default String	getDescription()	A description of the environment template.
default String	getDisplayName()	The name of the environment template as displayed in the developer interface.
default String	getEncryptionKey()	The customer provided encryption key for the environment template.
default String	getName()	The name of the environment template.
default String	getProvisioning()	When included, indicates that the environment template is for customer provisioned and managed infrastructure.
default List<CfnTag>	getTags()	An optional list of metadata items that you can associate with the AWS Proton environment template.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the environment template.

See Also:

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

getDisplayName

@Stability(Stable)
@Nullable
default String getDisplayName()

The name of the environment template as displayed in the developer interface.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmenttemplate.html#cfn-proton-environmenttemplate-displayname

getEncryptionKey

@Stability(Stable)
@Nullable
default String getEncryptionKey()

The customer provided encryption key for the environment template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmenttemplate.html#cfn-proton-environmenttemplate-encryptionkey

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the environment template.

See Also:

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

getProvisioning

@Stability(Stable)
@Nullable
default String getProvisioning()

When included, indicates that the environment template is for customer provisioned and managed infrastructure.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmenttemplate.html#cfn-proton-environmenttemplate-provisioning

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An optional list of metadata items that you can associate with the AWS Proton environment template.

A tag is a key-value pair.

For more information, see AWS Proton resources and tagging in the AWS Proton User Guide .

See Also:

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

builder

@Stability(Stable)
static CfnEnvironmentTemplateProps.Builder builder()

Returns:

a CfnEnvironmentTemplateProps.Builder of CfnEnvironmentTemplateProps