Package software.amazon.awscdk.services.proton

Class CfnEnvironmentTemplate

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.proton.CfnEnvironmentTemplate
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:01.013Z") @Stability(Stable) public class CfnEnvironmentTemplate extends CfnResource implements IInspectable
A CloudFormation AWS::Proton::EnvironmentTemplate.

Create an environment template for AWS Proton . For more information, see Environment Templates in the AWS Proton User Guide .

You can create an environment template in one of the two following ways:

  • Register and publish a standard environment template that instructs AWS Proton to deploy and manage environment infrastructure.
  • Register and publish a customer managed environment template that connects AWS Proton to your existing provisioned infrastructure that you manage. AWS Proton doesn't manage your existing provisioned infrastructure. To create an environment template for customer provisioned and managed infrastructure, include the provisioning parameter and set the value to CUSTOMER_MANAGED . For more information, see Register and publish an environment template in the AWS Proton User Guide .

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.*;
 CfnEnvironmentTemplate cfnEnvironmentTemplate = CfnEnvironmentTemplate.Builder.create(this, "MyCfnEnvironmentTemplate")
         .description("description")
         .displayName("displayName")
         .encryptionKey("encryptionKey")
         .name("name")
         .provisioning("provisioning")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnEnvironmentTemplate

      protected CfnEnvironmentTemplate(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnEnvironmentTemplate

      protected CfnEnvironmentTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnEnvironmentTemplate

      @Stability(Stable) public CfnEnvironmentTemplate(@NotNull Construct scope, @NotNull String id, @Nullable CfnEnvironmentTemplateProps props)
      Create a new AWS::Proton::EnvironmentTemplate.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnEnvironmentTemplate

      @Stability(Stable) public CfnEnvironmentTemplate(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::Proton::EnvironmentTemplate.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      Returns the ARN of the environment template.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager 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 .

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the environment template.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the environment template.

    • getDisplayName

      @Stability(Stable) @Nullable public String getDisplayName()
      The name of the environment template as displayed in the developer interface.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@Nullable String value)
      The name of the environment template as displayed in the developer interface.

    • getEncryptionKey

      @Stability(Stable) @Nullable public String getEncryptionKey()
      The customer provided encryption key for the environment template.

    • setEncryptionKey

      @Stability(Stable) public void setEncryptionKey(@Nullable String value)
      The customer provided encryption key for the environment template.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the environment template.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the environment template.

    • getProvisioning

      @Stability(Stable) @Nullable public String getProvisioning()
      When included, indicates that the environment template is for customer provisioned and managed infrastructure.

    • setProvisioning

      @Stability(Stable) public void setProvisioning(@Nullable String value)
      When included, indicates that the environment template is for customer provisioned and managed infrastructure.