Package software.amazon.awscdk.services.m2

Class CfnEnvironment.Builder

java.lang.Object

software.amazon.awscdk.services.m2.CfnEnvironment.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEnvironment>

Enclosing class:

CfnEnvironment

@Stability(Stable)
public static final class CfnEnvironment.Builder
extends Object
implements software.amazon.jsii.Builder<CfnEnvironment>

A fluent builder for CfnEnvironment.

Method Summary

Modifier and Type	Method	Description
CfnEnvironment	build()
static CfnEnvironment.Builder	create(software.constructs.Construct scope, String id)
CfnEnvironment.Builder	description(String description)	The description of the runtime environment.
CfnEnvironment.Builder	engineType(String engineType)	The target platform for the runtime environment.
CfnEnvironment.Builder	engineVersion(String engineVersion)	The version of the runtime engine.
CfnEnvironment.Builder	highAvailabilityConfig(IResolvable highAvailabilityConfig)
CfnEnvironment.Builder	highAvailabilityConfig(CfnEnvironment.HighAvailabilityConfigProperty highAvailabilityConfig)
CfnEnvironment.Builder	instanceType(String instanceType)	The instance type of the runtime environment.
CfnEnvironment.Builder	kmsKeyId(String kmsKeyId)	The identifier of a customer managed key.
CfnEnvironment.Builder	name(String name)	The name of the runtime environment.
CfnEnvironment.Builder	networkType(String networkType)	The network type supported by the runtime environment.
CfnEnvironment.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow)	Configures the maintenance window that you want for the runtime environment.
CfnEnvironment.Builder	publiclyAccessible(Boolean publiclyAccessible)	Specifies whether the runtime environment is publicly accessible.
CfnEnvironment.Builder	publiclyAccessible(IResolvable publiclyAccessible)	Specifies whether the runtime environment is publicly accessible.
CfnEnvironment.Builder	securityGroupIds(List<String> securityGroupIds)	The list of security groups for the VPC associated with this runtime environment.
CfnEnvironment.Builder	storageConfigurations(List<? extends Object> storageConfigurations)
CfnEnvironment.Builder	storageConfigurations(IResolvable storageConfigurations)
CfnEnvironment.Builder	subnetIds(List<String> subnetIds)	The list of subnets associated with the VPC for this runtime environment.
CfnEnvironment.Builder	tags(Map<String,String> tags)	An array of key-value pairs to apply to this resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnEnvironment.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnEnvironment.Builder.

engineType

@Stability(Stable)
public CfnEnvironment.Builder engineType(String engineType)

The target platform for the runtime environment.

Parameters:

engineType - The target platform for the runtime environment. This parameter is required.

Returns:

this

See Also:

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

instanceType

@Stability(Stable)
public CfnEnvironment.Builder instanceType(String instanceType)

The instance type of the runtime environment.

Parameters:

instanceType - The instance type of the runtime environment. This parameter is required.

Returns:

this

See Also:

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

name

@Stability(Stable)
public CfnEnvironment.Builder name(String name)

The name of the runtime environment.

Parameters:

name - The name of the runtime environment. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnEnvironment.Builder description(String description)

The description of the runtime environment.

Parameters:

description - The description of the runtime environment. This parameter is required.

Returns:

this

See Also:

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

engineVersion

@Stability(Stable)
public CfnEnvironment.Builder engineVersion(String engineVersion)

The version of the runtime engine.

Parameters:

engineVersion - The version of the runtime engine. This parameter is required.

Returns:

this

See Also:

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

highAvailabilityConfig

@Stability(Stable)
public CfnEnvironment.Builder highAvailabilityConfig(IResolvable highAvailabilityConfig)

AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025.

If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see AWS Mainframe Modernization availability change .

Defines the details of a high availability configuration.

Parameters:

highAvailabilityConfig -

AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025.

This parameter is required.

Returns:

this

See Also:

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

highAvailabilityConfig

@Stability(Stable)
public CfnEnvironment.Builder highAvailabilityConfig(CfnEnvironment.HighAvailabilityConfigProperty highAvailabilityConfig)

AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025.

If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see AWS Mainframe Modernization availability change .

Defines the details of a high availability configuration.

Parameters:

highAvailabilityConfig -

AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025.

This parameter is required.

Returns:

this

See Also:

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

kmsKeyId

@Stability(Stable)
public CfnEnvironment.Builder kmsKeyId(String kmsKeyId)

The identifier of a customer managed key.

Parameters:

kmsKeyId - The identifier of a customer managed key. This parameter is required.

Returns:

this

See Also:

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

networkType

@Stability(Stable)
public CfnEnvironment.Builder networkType(String networkType)

The network type supported by the runtime environment.

Parameters:

networkType - The network type supported by the runtime environment. This parameter is required.

Returns:

this

See Also:

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

preferredMaintenanceWindow

@Stability(Stable)
public CfnEnvironment.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)

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.

Parameters:

preferredMaintenanceWindow - Configures the maintenance window that you want for the runtime environment. This parameter is required.

Returns:

this

See Also:

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

publiclyAccessible

@Stability(Stable)
public CfnEnvironment.Builder publiclyAccessible(Boolean publiclyAccessible)

Specifies whether the runtime environment is publicly accessible.

Parameters:

publiclyAccessible - Specifies whether the runtime environment is publicly accessible. This parameter is required.

Returns:

this

See Also:

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

publiclyAccessible

@Stability(Stable)
public CfnEnvironment.Builder publiclyAccessible(IResolvable publiclyAccessible)

Specifies whether the runtime environment is publicly accessible.

Parameters:

publiclyAccessible - Specifies whether the runtime environment is publicly accessible. This parameter is required.

Returns:

this

See Also:

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

securityGroupIds

@Stability(Stable)
public CfnEnvironment.Builder securityGroupIds(List<String> securityGroupIds)

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

Parameters:

securityGroupIds - The list of security groups for the VPC associated with this runtime environment. This parameter is required.

Returns:

this

See Also:

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

storageConfigurations

@Stability(Stable)
public CfnEnvironment.Builder storageConfigurations(IResolvable storageConfigurations)

AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025.

If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see AWS Mainframe Modernization availability change .

Defines the storage configuration for a runtime environment.

Parameters:

storageConfigurations -

AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025.

This parameter is required.

Returns:

this

See Also:

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

storageConfigurations

@Stability(Stable)
public CfnEnvironment.Builder storageConfigurations(List<? extends Object> storageConfigurations)

AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025.

If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see AWS Mainframe Modernization availability change .

Defines the storage configuration for a runtime environment.

Parameters:

storageConfigurations -

AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025.

This parameter is required.

Returns:

this

See Also:

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

subnetIds

@Stability(Stable)
public CfnEnvironment.Builder subnetIds(List<String> subnetIds)

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

Parameters:

subnetIds - The list of subnets associated with the VPC for this runtime environment. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnEnvironment.Builder tags(Map<String,String> tags)

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

For more information, see Tag .

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnEnvironment build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnEnvironment>

Returns:

a newly built instance of CfnEnvironment.