Class CfnServiceTemplate
A CloudFormation AWS::Proton::ServiceTemplate
.
Inherited Members
Namespace: Amazon.CDK.AWS.Proton
Assembly: Amazon.CDK.AWS.Proton.dll
Syntax (csharp)
public class CfnServiceTemplate : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnServiceTemplate
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 .
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 |
CfnServiceTemplate(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnServiceTemplate(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | Returns the service template ARN. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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 |
Tags | An object that includes the template bundle S3 bucket path and name for the new version of a service template. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
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 System.String
- scoped id of the resource.
- props ICfnServiceTemplateProps
- resource properties.
CfnServiceTemplate(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnServiceTemplate(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnServiceTemplate(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnServiceTemplate(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
Returns the service template ARN.
public virtual string AttrArn { get; }
Property Value
System.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
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
A description of the service template.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
DisplayName
The service template name as displayed in the developer interface.
public virtual string DisplayName { get; set; }
Property Value
System.String
Remarks
EncryptionKey
The customer provided service template encryption key that's used to encrypt data.
public virtual string EncryptionKey { get; set; }
Property Value
System.String
Remarks
Name
The name of the service template.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
PipelineProvisioning
If pipelineProvisioning
is true
, a service pipeline is included in the service template.
public virtual string PipelineProvisioning { get; set; }
Property Value
System.String
Remarks
Otherwise, a service pipeline isn't included in the service template.
Tags
An object that includes the template bundle S3 bucket path and name for the new version of a service template.
public virtual TagManager Tags { get; }
Property Value
Remarks
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>