Class CfnServiceTemplate

Create a service template.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnServiceTemplate

Implements

IInspectable

IServiceTemplateRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Proton

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnServiceTemplate : CfnResource, IInspectable, IServiceTemplateRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnServiceTemplate Inherits CfnResource Implements IInspectable, IServiceTemplateRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-servicetemplate.html

CloudformationResource: AWS::Proton::ServiceTemplate

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Proton;

             var cfnServiceTemplate = new CfnServiceTemplate(this, "MyCfnServiceTemplate", new CfnServiceTemplateProps {
                 Description = "description",
                 DisplayName = "displayName",
                 EncryptionKey = "encryptionKey",
                 Name = "name",
                 PipelineProvisioning = "pipelineProvisioning",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnServiceTemplate(Construct, string, ICfnServiceTemplateProps?)

Create a new AWS::Proton::ServiceTemplate.

Properties

AttrArn	Returns the service template ARN.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Create a service template.
Description	A description of the service template.
DisplayName	The service template name as displayed in the developer interface.
EncryptionKey	The customer provided service template encryption key that's used to encrypt data.
Name	The name of the service template.
PipelineProvisioning	If pipelineProvisioning is true , a service pipeline is included in the service template.
ServiceTemplateRef	A reference to a ServiceTemplate resource.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	An object that includes the template bundle S3 bucket path and name for the new version of a service template.

Methods

ArnForServiceTemplate(IServiceTemplateRef)	Create a service template.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnServiceTemplate(object)	Checks whether the given object is a CfnServiceTemplate.
RenderProperties(IDictionary<string, object>)	Create a service template.

Constructors

CfnServiceTemplate(Construct, string, ICfnServiceTemplateProps?)

Create a new AWS::Proton::ServiceTemplate.

public CfnServiceTemplate(Construct scope, string id, ICfnServiceTemplateProps? props = null)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnServiceTemplateProps

Resource properties.

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-servicetemplate.html

CloudformationResource: AWS::Proton::ServiceTemplate

ExampleMetadata: fixture=_generated

Properties

AttrArn

Returns the service template ARN.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-servicetemplate.html

CloudformationResource: AWS::Proton::ServiceTemplate

ExampleMetadata: fixture=_generated

CfnProperties

Create a service template.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-servicetemplate.html

CloudformationResource: AWS::Proton::ServiceTemplate

ExampleMetadata: fixture=_generated

Description

A description of the service template.

public virtual string? Description { get; set; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-servicetemplate.html

CloudformationResource: AWS::Proton::ServiceTemplate

ExampleMetadata: fixture=_generated

DisplayName

The service template name as displayed in the developer interface.

public virtual string? DisplayName { get; set; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-servicetemplate.html

CloudformationResource: AWS::Proton::ServiceTemplate

ExampleMetadata: fixture=_generated

EncryptionKey

The customer provided service template encryption key that's used to encrypt data.

public virtual string? EncryptionKey { get; set; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-servicetemplate.html

CloudformationResource: AWS::Proton::ServiceTemplate

ExampleMetadata: fixture=_generated

Name

The name of the service template.

public virtual string? Name { get; set; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-servicetemplate.html

CloudformationResource: AWS::Proton::ServiceTemplate

ExampleMetadata: fixture=_generated

PipelineProvisioning

If pipelineProvisioning is true , a service pipeline is included in the service template.

public virtual string? PipelineProvisioning { get; set; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-servicetemplate.html

CloudformationResource: AWS::Proton::ServiceTemplate

ExampleMetadata: fixture=_generated

ServiceTemplateRef

A reference to a ServiceTemplate resource.

public virtual IServiceTemplateReference ServiceTemplateRef { get; }

Property Value

IServiceTemplateReference

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-servicetemplate.html

CloudformationResource: AWS::Proton::ServiceTemplate

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-servicetemplate.html

CloudformationResource: AWS::Proton::ServiceTemplate

ExampleMetadata: fixture=_generated

TagsRaw

An object that includes the template bundle S3 bucket path and name for the new version of a service template.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-servicetemplate.html

CloudformationResource: AWS::Proton::ServiceTemplate

ExampleMetadata: fixture=_generated

Methods

ArnForServiceTemplate(IServiceTemplateRef)

Create a service template.

public static string ArnForServiceTemplate(IServiceTemplateRef resource)

Parameters

resource IServiceTemplateRef

Returns

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-servicetemplate.html

CloudformationResource: AWS::Proton::ServiceTemplate

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Proton;

             var cfnServiceTemplate = new CfnServiceTemplate(this, "MyCfnServiceTemplate", new CfnServiceTemplateProps {
                 Description = "description",
                 DisplayName = "displayName",
                 EncryptionKey = "encryptionKey",
                 Name = "name",
                 PipelineProvisioning = "pipelineProvisioning",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-servicetemplate.html

CloudformationResource: AWS::Proton::ServiceTemplate

ExampleMetadata: fixture=_generated

IsCfnServiceTemplate(object)

Checks whether the given object is a CfnServiceTemplate.

public static bool IsCfnServiceTemplate(object x)

Parameters

x object

Returns

bool

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-servicetemplate.html

CloudformationResource: AWS::Proton::ServiceTemplate

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Create a service template.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-servicetemplate.html

CloudformationResource: AWS::Proton::ServiceTemplate

ExampleMetadata: fixture=_generated

Implements

IInspectable

IServiceTemplateRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable