Interface CfnEnvironmentProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnEnvironmentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:59.842Z") @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();
 
  • Method Details

    • getEngineType

      @Stability(Stable) @NotNull String getEngineType()
      The target platform for the runtime environment.
    • getInstanceType

      @Stability(Stable) @NotNull String getInstanceType()
      The instance type of the runtime environment.
    • getName

      @Stability(Stable) @NotNull String getName()
      The name of the runtime environment.
    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      The description of the runtime environment.
    • getEngineVersion

      @Stability(Stable) @Nullable default String getEngineVersion()
      The version of the runtime engine.
    • getHighAvailabilityConfig

      @Stability(Stable) @Nullable default Object getHighAvailabilityConfig()
      Defines the details of a high availability configuration.
    • getKmsKeyId

      @Stability(Stable) @Nullable default String getKmsKeyId()
      The identifier of a customer managed key.
    • getPreferredMaintenanceWindow

      @Stability(Stable) @Nullable default String getPreferredMaintenanceWindow()
      Configures the maintenance window you want for the runtime environment.

      If you do not provide a value, a random system-generated value will be assigned.

    • getPubliclyAccessible

      @Stability(Stable) @Nullable default Object getPubliclyAccessible()
      Specifies whether the runtime environment is publicly accessible.
    • getSecurityGroupIds

      @Stability(Stable) @Nullable default List<String> getSecurityGroupIds()
      The list of security groups for the VPC associated with this runtime environment.
    • getStorageConfigurations

      @Stability(Stable) @Nullable default Object getStorageConfigurations()
      Defines the storage configuration for a runtime environment.
    • getSubnetIds

      @Stability(Stable) @Nullable default List<String> getSubnetIds()
      The list of subnets associated with the VPC for this runtime environment.
    • 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 .

    • builder

      @Stability(Stable) static CfnEnvironmentProps.Builder builder()
      Returns:
      a CfnEnvironmentProps.Builder of CfnEnvironmentProps