Class CfnEnvironment
Specifies a runtime environment for a given runtime engine.
Inherited Members
Namespace: Amazon.CDK.AWS.M2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnEnvironment : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnEnvironment
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html
CloudformationResource: AWS::M2::Environment
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.M2;
var cfnEnvironment = new CfnEnvironment(this, "MyCfnEnvironment", new CfnEnvironmentProps {
EngineType = "engineType",
InstanceType = "instanceType",
Name = "name",
// the properties below are optional
Description = "description",
EngineVersion = "engineVersion",
HighAvailabilityConfig = new HighAvailabilityConfigProperty {
DesiredCapacity = 123
},
KmsKeyId = "kmsKeyId",
PreferredMaintenanceWindow = "preferredMaintenanceWindow",
PubliclyAccessible = false,
SecurityGroupIds = new [] { "securityGroupIds" },
StorageConfigurations = new [] { new StorageConfigurationProperty {
Efs = new EfsStorageConfigurationProperty {
FileSystemId = "fileSystemId",
MountPoint = "mountPoint"
},
Fsx = new FsxStorageConfigurationProperty {
FileSystemId = "fileSystemId",
MountPoint = "mountPoint"
}
} },
SubnetIds = new [] { "subnetIds" },
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
}
});
Synopsis
Constructors
CfnEnvironment(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnEnvironment(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnEnvironment(Construct, String, ICfnEnvironmentProps) |
Properties
AttrEnvironmentArn | The Amazon Resource Name (ARN) of the runtime environment. |
AttrEnvironmentId | The unique identifier of the runtime environment. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | The description of the runtime environment. |
EngineType | The target platform for the runtime environment. |
EngineVersion | The version of the runtime engine. |
HighAvailabilityConfig | Defines the details of a high availability configuration. |
InstanceType | The instance type of the runtime environment. |
KmsKeyId | The identifier of a customer managed key. |
Name | The name of the runtime environment. |
PreferredMaintenanceWindow | Configures the maintenance window that you want for the runtime environment. |
PubliclyAccessible | Specifies whether the runtime environment is publicly accessible. |
SecurityGroupIds | The list of security groups for the VPC associated with this runtime environment. |
StorageConfigurations | Defines the storage configuration for a runtime environment. |
SubnetIds | The list of subnets associated with the VPC for this runtime environment. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | An array of key-value pairs to apply to this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnEnvironment(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnEnvironment(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnEnvironment(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnEnvironment(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnEnvironment(Construct, String, ICfnEnvironmentProps)
public CfnEnvironment(Construct scope, string id, ICfnEnvironmentProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnEnvironmentProps
Resource properties.
Properties
AttrEnvironmentArn
The Amazon Resource Name (ARN) of the runtime environment.
public virtual string AttrEnvironmentArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: EnvironmentArn
AttrEnvironmentId
The unique identifier of the runtime environment.
public virtual string AttrEnvironmentId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: EnvironmentId
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
The description of the runtime environment.
public virtual string Description { get; set; }
Property Value
System.String
EngineType
The target platform for the runtime environment.
public virtual string EngineType { get; set; }
Property Value
System.String
EngineVersion
The version of the runtime engine.
public virtual string EngineVersion { get; set; }
Property Value
System.String
HighAvailabilityConfig
Defines the details of a high availability configuration.
public virtual object HighAvailabilityConfig { get; set; }
Property Value
System.Object
InstanceType
The instance type of the runtime environment.
public virtual string InstanceType { get; set; }
Property Value
System.String
KmsKeyId
The identifier of a customer managed key.
public virtual string KmsKeyId { get; set; }
Property Value
System.String
Name
The name of the runtime environment.
public virtual string Name { get; set; }
Property Value
System.String
PreferredMaintenanceWindow
Configures the maintenance window that you want for the runtime environment.
public virtual string PreferredMaintenanceWindow { get; set; }
Property Value
System.String
PubliclyAccessible
Specifies whether the runtime environment is publicly accessible.
public virtual object PubliclyAccessible { get; set; }
Property Value
System.Object
SecurityGroupIds
The list of security groups for the VPC associated with this runtime environment.
public virtual string[] SecurityGroupIds { get; set; }
Property Value
System.String[]
StorageConfigurations
Defines the storage configuration for a runtime environment.
public virtual object StorageConfigurations { get; set; }
Property Value
System.Object
SubnetIds
The list of subnets associated with the VPC for this runtime environment.
public virtual string[] SubnetIds { get; set; }
Property Value
System.String[]
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
An array of key-value pairs to apply to this resource.
public virtual IDictionary<string, string> TagsRaw { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
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>