Package services.proton

Class CfnServiceTemplate

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
services.proton.CfnServiceTemplate
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.89.0 (build 2f74b3e)", date="2023-11-02T10:21:21.079Z") @Stability(Stable) public class CfnServiceTemplate extends CfnResource implements IInspectable, ITaggable
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 . If the selected service template includes a service pipeline definition, they provide a link to their source code repository. then deploys and manages the infrastructure defined by the selected service template. For more information, see templates in the User Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import 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();

See Also:

  • 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 software.constructs.Construct scope, @NotNull String id, @Nullable CfnServiceTemplateProps props)
      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.
      props - Resource properties.

    • CfnServiceTemplate

      @Stability(Stable) public CfnServiceTemplate(@NotNull software.constructs.Construct scope, @NotNull 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.

  • 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()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • 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.

    • setPipelineProvisioning

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

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An object that includes the template bundle S3 bucket path and name for the new version of a service template.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An object that includes the template bundle S3 bucket path and name for the new version of a service template.