Show / Hide Table of Contents

Class CfnEnvironmentTemplate

A CloudFormation AWS::Proton::EnvironmentTemplate.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnEnvironmentTemplate
Implements
IConstruct
Constructs.IConstruct
IDependable
IInspectable
Inherited Members
CfnResource.IsCfnResource(IConstruct)
CfnResource.AddDeletionOverride(String)
CfnResource.AddDependsOn(CfnResource)
CfnResource.AddMetadata(String, Object)
CfnResource.AddOverride(String, Object)
CfnResource.AddPropertyDeletionOverride(String)
CfnResource.AddPropertyOverride(String, Object)
CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)
CfnResource.GetAtt(String)
CfnResource.GetMetadata(String)
CfnResource.ShouldSynthesize()
CfnResource.ToString()
CfnResource.ValidateProperties(Object)
CfnResource.CfnOptions
CfnResource.CfnResourceType
CfnResource.UpdatedProperites
CfnRefElement.Ref
CfnElement.IsCfnElement(Object)
CfnElement.OverrideLogicalId(String)
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Construct.IsConstruct(Object)
Construct.OnPrepare()
Construct.OnSynthesize(ISynthesisSession)
Construct.OnValidate()
Construct.Prepare()
Construct.Synthesize(ISynthesisSession)
Construct.Validate()
Construct.Node
Namespace: Amazon.CDK.AWS.Proton
Assembly: Amazon.CDK.AWS.Proton.dll
Syntax (csharp)
public class CfnEnvironmentTemplate : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnEnvironmentTemplate
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable
Remarks

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:

    CloudformationResource: AWS::Proton::EnvironmentTemplate

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmenttemplate.html

    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 cfnEnvironmentTemplate = new CfnEnvironmentTemplate(this, "MyCfnEnvironmentTemplate", new CfnEnvironmentTemplateProps {
        Description = "description",
        DisplayName = "displayName",
        EncryptionKey = "encryptionKey",
        Name = "name",
        Provisioning = "provisioning",
        Tags = new [] { new CfnTag {
            Key = "key",
            Value = "value"
        } }
    });

    Synopsis

    Constructors

    CfnEnvironmentTemplate(Construct, String, ICfnEnvironmentTemplateProps)

    Create a new AWS::Proton::EnvironmentTemplate.

    CfnEnvironmentTemplate(ByRefValue)

    Used by jsii to construct an instance of this class from a Javascript-owned object reference

    CfnEnvironmentTemplate(DeputyBase.DeputyProps)

    Used by jsii to construct an instance of this class from DeputyProps

    Properties

    AttrArn

    Returns the ARN of the environment template.

    CFN_RESOURCE_TYPE_NAME

    The CloudFormation resource type name for this resource class.

    CfnProperties
    Description

    A description of the environment template.

    DisplayName

    The name of the environment template as displayed in the developer interface.

    EncryptionKey

    The customer provided encryption key for the environment template.

    Name

    The name of the environment template.

    Provisioning

    When included, indicates that the environment template is for customer provisioned and managed infrastructure.

    Tags

    An optional list of metadata items that you can associate with the AWS Proton environment template.

    Methods

    Inspect(TreeInspector)

    Examines the CloudFormation resource and discloses attributes.

    RenderProperties(IDictionary<String, Object>)

    Constructors

    CfnEnvironmentTemplate(Construct, String, ICfnEnvironmentTemplateProps)

    Create a new AWS::Proton::EnvironmentTemplate.

    public CfnEnvironmentTemplate(Construct scope, string id, ICfnEnvironmentTemplateProps props = null)
    Parameters
    scope Construct
    • scope in which this resource is defined.
    id System.String
    • scoped id of the resource.
    props ICfnEnvironmentTemplateProps
    • resource properties.

    CfnEnvironmentTemplate(ByRefValue)

    Used by jsii to construct an instance of this class from a Javascript-owned object reference

    protected CfnEnvironmentTemplate(ByRefValue reference)
    Parameters
    reference Amazon.JSII.Runtime.Deputy.ByRefValue

    The Javascript-owned object reference

    CfnEnvironmentTemplate(DeputyBase.DeputyProps)

    Used by jsii to construct an instance of this class from DeputyProps

    protected CfnEnvironmentTemplate(DeputyBase.DeputyProps props)
    Parameters
    props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

    The deputy props

    Properties

    AttrArn

    Returns the ARN of the environment template.

    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
    CfnResource.CfnProperties

    Description

    A description of the environment template.

    public virtual string Description { get; set; }
    Property Value

    System.String

    Remarks

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmenttemplate.html#cfn-proton-environmenttemplate-description

    DisplayName

    The name of the environment template as displayed in the developer interface.

    public virtual string DisplayName { get; set; }
    Property Value

    System.String

    Remarks

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmenttemplate.html#cfn-proton-environmenttemplate-displayname

    EncryptionKey

    The customer provided encryption key for the environment template.

    public virtual string EncryptionKey { get; set; }
    Property Value

    System.String

    Remarks

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmenttemplate.html#cfn-proton-environmenttemplate-encryptionkey

    Name

    The name of the environment template.

    public virtual string Name { get; set; }
    Property Value

    System.String

    Remarks

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmenttemplate.html#cfn-proton-environmenttemplate-name

    Provisioning

    When included, indicates that the environment template is for customer provisioned and managed infrastructure.

    public virtual string Provisioning { get; set; }
    Property Value

    System.String

    Remarks

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmenttemplate.html#cfn-proton-environmenttemplate-provisioning

    Tags

    An optional list of metadata items that you can associate with the AWS Proton environment template.

    public virtual TagManager Tags { get; }
    Property Value

    TagManager

    Remarks

    A tag is a key-value pair.

    For more information, see AWS Proton resources and tagging in the AWS Proton User Guide .

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmenttemplate.html#cfn-proton-environmenttemplate-tags

    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>

    Overrides
    CfnResource.RenderProperties(IDictionary<String, Object>)

    Implements

    IConstruct
    Constructs.IConstruct
    IDependable
    IInspectable
    Back to top Generated by DocFX