Package software.amazon.awscdk.services.m2

Interface CfnEnvironmentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEnvironmentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:12.565Z")
@Stability(Stable)
public interface CfnEnvironmentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnEnvironment.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.m2.*;
 CfnEnvironmentProps cfnEnvironmentProps = CfnEnvironmentProps.builder()
         .engineType("engineType")
         .instanceType("instanceType")
         .name("name")
         // the properties below are optional
         .description("description")
         .engineVersion("engineVersion")
         .highAvailabilityConfig(HighAvailabilityConfigProperty.builder()
                 .desiredCapacity(123)
                 .build())
         .kmsKeyId("kmsKeyId")
         .preferredMaintenanceWindow("preferredMaintenanceWindow")
         .publiclyAccessible(false)
         .securityGroupIds(List.of("securityGroupIds"))
         .storageConfigurations(List.of(StorageConfigurationProperty.builder()
                 .efs(EfsStorageConfigurationProperty.builder()
                         .fileSystemId("fileSystemId")
                         .mountPoint("mountPoint")
                         .build())
                 .fsx(FsxStorageConfigurationProperty.builder()
                         .fileSystemId("fileSystemId")
                         .mountPoint("mountPoint")
                         .build())
                 .build()))
         .subnetIds(List.of("subnetIds"))
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEnvironmentProps.Builder	A builder for CfnEnvironmentProps
static final class	CfnEnvironmentProps.Jsii$Proxy	An implementation for CfnEnvironmentProps

Method Summary

Modifier and Type	Method	Description
static CfnEnvironmentProps.Builder	builder()
default String	getDescription()	The description of the runtime environment.
String	getEngineType()	The target platform for the runtime environment.
default String	getEngineVersion()	The version of the runtime engine.
default Object	getHighAvailabilityConfig()	Defines the details of a high availability configuration.
String	getInstanceType()	The instance type of the runtime environment.
default String	getKmsKeyId()	The identifier of a customer managed key.
String	getName()	The name of the runtime environment.
default String	getPreferredMaintenanceWindow()	Configures the maintenance window that you want for the runtime environment.
default Object	getPubliclyAccessible()	Specifies whether the runtime environment is publicly accessible.
default List<String>	getSecurityGroupIds()	The list of security groups for the VPC associated with this runtime environment.
default Object	getStorageConfigurations()	Defines the storage configuration for a runtime environment.
default List<String>	getSubnetIds()	The list of subnets associated with the VPC for this runtime environment.
default Map<String,String>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEngineType

@Stability(Stable)
@NotNull
String getEngineType()

The target platform for the runtime environment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-enginetype

getInstanceType

@Stability(Stable)
@NotNull
String getInstanceType()

The instance type of the runtime environment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-instancetype

getName

@Stability(Stable)
@NotNull
String getName()

The name of the runtime environment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-name

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the runtime environment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-description

getEngineVersion

@Stability(Stable)
@Nullable
default String getEngineVersion()

The version of the runtime engine.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-engineversion

getHighAvailabilityConfig

@Stability(Stable)
@Nullable
default Object getHighAvailabilityConfig()

Defines the details of a high availability configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-highavailabilityconfig

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

The identifier of a customer managed key.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-kmskeyid

getPreferredMaintenanceWindow

@Stability(Stable)
@Nullable
default String getPreferredMaintenanceWindow()

Configures the maintenance window that you want for the runtime environment.

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-preferredmaintenancewindow

getPubliclyAccessible

@Stability(Stable)
@Nullable
default Object getPubliclyAccessible()

Specifies whether the runtime environment is publicly accessible.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-publiclyaccessible

getSecurityGroupIds

@Stability(Stable)
@Nullable
default List<String> getSecurityGroupIds()

The list of security groups for the VPC associated with this runtime environment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-securitygroupids

getStorageConfigurations

@Stability(Stable)
@Nullable
default Object getStorageConfigurations()

Defines the storage configuration for a runtime environment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-storageconfigurations

getSubnetIds

@Stability(Stable)
@Nullable
default List<String> getSubnetIds()

The list of subnets associated with the VPC for this runtime environment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-subnetids

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-tags

builder

@Stability(Stable)
static CfnEnvironmentProps.Builder builder()

Returns:

a CfnEnvironmentProps.Builder of CfnEnvironmentProps