Package software.amazon.awscdk.services.m2

Class CfnEnvironment

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.m2.CfnEnvironment
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:59.838Z") @Stability(Stable) public class CfnEnvironment extends CfnResource implements IInspectable
A CloudFormation AWS::M2::Environment.

Specifies a runtime environment for a given runtime engine.

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.*;
 CfnEnvironment cfnEnvironment = CfnEnvironment.Builder.create(this, "MyCfnEnvironment")
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnEnvironment

      protected CfnEnvironment(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnEnvironment

      protected CfnEnvironment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnEnvironment

      @Stability(Stable) public CfnEnvironment(@NotNull Construct scope, @NotNull String id, @NotNull CfnEnvironmentProps props)
      Create a new AWS::M2::Environment.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrEnvironmentArn

      @Stability(Stable) @NotNull public String getAttrEnvironmentArn()
      The Amazon Resource Name (ARN) of the runtime environment.

    • getAttrEnvironmentId

      @Stability(Stable) @NotNull public String getAttrEnvironmentId()
      The unique identifier of the runtime environment.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • getEngineType

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

    • setEngineType

      @Stability(Stable) public void setEngineType(@NotNull String value)
      The target platform for the runtime environment.

    • getInstanceType

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

    • setInstanceType

      @Stability(Stable) public void setInstanceType(@NotNull String value)
      The instance type of the runtime environment.

    • getName

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

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the runtime environment.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the runtime environment.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the runtime environment.

    • getEngineVersion

      @Stability(Stable) @Nullable public String getEngineVersion()
      The version of the runtime engine.

    • setEngineVersion

      @Stability(Stable) public void setEngineVersion(@Nullable String value)
      The version of the runtime engine.

    • getHighAvailabilityConfig

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

    • setHighAvailabilityConfig

      @Stability(Stable) public void setHighAvailabilityConfig(@Nullable IResolvable value)
      Defines the details of a high availability configuration.

    • setHighAvailabilityConfig

      @Stability(Stable) public void setHighAvailabilityConfig(@Nullable CfnEnvironment.HighAvailabilityConfigProperty value)
      Defines the details of a high availability configuration.

    • getKmsKeyId

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

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      The identifier of a customer managed key.

    • getPreferredMaintenanceWindow

      @Stability(Stable) @Nullable public 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.

    • setPreferredMaintenanceWindow

      @Stability(Stable) public void setPreferredMaintenanceWindow(@Nullable String value)
      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 public Object getPubliclyAccessible()
      Specifies whether the runtime environment is publicly accessible.

    • setPubliclyAccessible

      @Stability(Stable) public void setPubliclyAccessible(@Nullable Boolean value)
      Specifies whether the runtime environment is publicly accessible.

    • setPubliclyAccessible

      @Stability(Stable) public void setPubliclyAccessible(@Nullable IResolvable value)
      Specifies whether the runtime environment is publicly accessible.

    • getSecurityGroupIds

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

    • setSecurityGroupIds

      @Stability(Stable) public void setSecurityGroupIds(@Nullable List<String> value)
      The list of security groups for the VPC associated with this runtime environment.

    • getStorageConfigurations

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

    • setStorageConfigurations

      @Stability(Stable) public void setStorageConfigurations(@Nullable IResolvable value)
      Defines the storage configuration for a runtime environment.

    • setStorageConfigurations

      @Stability(Stable) public void setStorageConfigurations(@Nullable List<Object> value)
      Defines the storage configuration for a runtime environment.

    • getSubnetIds

      @Stability(Stable) @Nullable public List<String> getSubnetIds()
      The list of subnets associated with the VPC for this runtime environment.

    • setSubnetIds

      @Stability(Stable) public void setSubnetIds(@Nullable List<String> value)
      The list of subnets associated with the VPC for this runtime environment.