Class CfnEnvironmentProps
Properties for defining a CfnEnvironment
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.M2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnEnvironmentProps : Object, ICfnEnvironmentProps
Syntax (vb)
Public Class CfnEnvironmentProps
Inherits Object
Implements ICfnEnvironmentProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.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.M2;
var cfnEnvironmentProps = 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
CfnEnvironmentProps() |
Properties
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 | An array of key-value pairs to apply to this resource. |
Constructors
CfnEnvironmentProps()
public CfnEnvironmentProps()
Properties
Description
The description of the runtime environment.
public string Description { get; set; }
Property Value
System.String
Remarks
EngineType
The target platform for the runtime environment.
public string EngineType { get; set; }
Property Value
System.String
Remarks
EngineVersion
The version of the runtime engine.
public string EngineVersion { get; set; }
Property Value
System.String
Remarks
HighAvailabilityConfig
Defines the details of a high availability configuration.
public object HighAvailabilityConfig { get; set; }
Property Value
System.Object
Remarks
InstanceType
The instance type of the runtime environment.
public string InstanceType { get; set; }
Property Value
System.String
Remarks
KmsKeyId
The identifier of a customer managed key.
public string KmsKeyId { get; set; }
Property Value
System.String
Remarks
Name
The name of the runtime environment.
public string Name { get; set; }
Property Value
System.String
Remarks
PreferredMaintenanceWindow
Configures the maintenance window that you want for the runtime environment.
public string PreferredMaintenanceWindow { get; set; }
Property Value
System.String
Remarks
The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi
and must be less than 24 hours. The following two examples are valid maintenance windows: sun:23:45-mon:00:15
or sat:01:00-sat:03:00
.
If you do not provide a value, a random system-generated value will be assigned.
PubliclyAccessible
Specifies whether the runtime environment is publicly accessible.
public object PubliclyAccessible { get; set; }
Property Value
System.Object
Remarks
SecurityGroupIds
The list of security groups for the VPC associated with this runtime environment.
public string[] SecurityGroupIds { get; set; }
Property Value
System.String[]
Remarks
StorageConfigurations
Defines the storage configuration for a runtime environment.
public object StorageConfigurations { get; set; }
Property Value
System.Object
Remarks
SubnetIds
The list of subnets associated with the VPC for this runtime environment.
public string[] SubnetIds { get; set; }
Property Value
System.String[]
Remarks
Tags
An array of key-value pairs to apply to this resource.
public IDictionary<string, string> Tags { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
For more information, see Tag .