Package software.amazon.awscdk.services.proton

Class CfnServiceTemplate

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.CfnServiceTemplate
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.015Z") @Stability(Stable) public class CfnServiceTemplate extends CfnResource implements IInspectable
A CloudFormation AWS::Proton::ServiceTemplate.

Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CI/CD service pipeline. Developers, in turn, select the service template from AWS Proton . If the selected service template includes a service pipeline definition, they provide a link to their source code repository. AWS Proton then deploys and manages the infrastructure defined by the selected service template. For more information, see AWS Proton templates 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.*;
 CfnServiceTemplate cfnServiceTemplate = CfnServiceTemplate.Builder.create(this, "MyCfnServiceTemplate")
         .description("description")
         .displayName("displayName")
         .encryptionKey("encryptionKey")
         .name("name")
         .pipelineProvisioning("pipelineProvisioning")
         .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

    • CfnServiceTemplate

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

    • CfnServiceTemplate

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

    • CfnServiceTemplate

      @Stability(Stable) public CfnServiceTemplate(@NotNull Construct scope, @NotNull String id, @Nullable CfnServiceTemplateProps props)
      Create a new AWS::Proton::ServiceTemplate.

      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.

    • CfnServiceTemplate

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

      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 service template ARN.

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An object that includes the template bundle S3 bucket path and name for the new version of a service template.

    • getDescription

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

    • setDescription

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

    • getDisplayName

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

    • setDisplayName

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

    • getEncryptionKey

      @Stability(Stable) @Nullable public String getEncryptionKey()
      The customer provided service template encryption key that's used to encrypt data.

    • setEncryptionKey

      @Stability(Stable) public void setEncryptionKey(@Nullable String value)
      The customer provided service template encryption key that's used to encrypt data.

    • getName

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

    • setName

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

    • getPipelineProvisioning

      @Stability(Stable) @Nullable public String getPipelineProvisioning()
      If pipelineProvisioning is true , a service pipeline is included in the service template.

      Otherwise, a service pipeline isn't included in the service template.

    • setPipelineProvisioning

      @Stability(Stable) public void setPipelineProvisioning(@Nullable String value)
      If pipelineProvisioning is true , a service pipeline is included in the service template.

      Otherwise, a service pipeline isn't included in the service template.