software.amazon.awscdk.services.m2

Class CfnEnvironment

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.m2.CfnEnvironment

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.741Z")
 @Stability(value=Stable)
public class CfnEnvironment
extends CfnResource
implements IInspectable

A CloudFormation `AWS::M2::Environment`.

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.*;
 Object storageConfigurations;
 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())
         .preferredMaintenanceWindow("preferredMaintenanceWindow")
         .publiclyAccessible(false)
         .securityGroupIds(List.of("securityGroupIds"))
         .storageConfigurations(List.of(storageConfigurations))
         .subnetIds(List.of("subnetIds"))
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnEnvironment.Builder A fluent builder for CfnEnvironment.
static interface	CfnEnvironment.HighAvailabilityConfigProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnEnvironment(software.constructs.Construct scope, String id, CfnEnvironmentProps props) Create a new `AWS::M2::Environment`.
protected	CfnEnvironment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEnvironment(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrEnvironmentArn()
String	getAttrEnvironmentId()
protected Map<String,Object>	getCfnProperties()
String	getDescription() `AWS::M2::Environment.Description`.
String	getEngineType() `AWS::M2::Environment.EngineType`.
String	getEngineVersion() `AWS::M2::Environment.EngineVersion`.
Object	getHighAvailabilityConfig() `AWS::M2::Environment.HighAvailabilityConfig`.
String	getInstanceType() `AWS::M2::Environment.InstanceType`.
String	getName() `AWS::M2::Environment.Name`.
String	getPreferredMaintenanceWindow() `AWS::M2::Environment.PreferredMaintenanceWindow`.
Object	getPubliclyAccessible() `AWS::M2::Environment.PubliclyAccessible`.
List<String>	getSecurityGroupIds() `AWS::M2::Environment.SecurityGroupIds`.
Object	getStorageConfigurations() `AWS::M2::Environment.StorageConfigurations`.
List<String>	getSubnetIds() `AWS::M2::Environment.SubnetIds`.
TagManager	getTags() `AWS::M2::Environment.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) `AWS::M2::Environment.Description`.
void	setEngineType(String value) `AWS::M2::Environment.EngineType`.
void	setEngineVersion(String value) `AWS::M2::Environment.EngineVersion`.
void	setHighAvailabilityConfig(CfnEnvironment.HighAvailabilityConfigProperty value) `AWS::M2::Environment.HighAvailabilityConfig`.
void	setHighAvailabilityConfig(IResolvable value) `AWS::M2::Environment.HighAvailabilityConfig`.
void	setInstanceType(String value) `AWS::M2::Environment.InstanceType`.
void	setName(String value) `AWS::M2::Environment.Name`.
void	setPreferredMaintenanceWindow(String value) `AWS::M2::Environment.PreferredMaintenanceWindow`.
void	setPubliclyAccessible(Boolean value) `AWS::M2::Environment.PubliclyAccessible`.
void	setPubliclyAccessible(IResolvable value) `AWS::M2::Environment.PubliclyAccessible`.
void	setSecurityGroupIds(List<String> value) `AWS::M2::Environment.SecurityGroupIds`.
void	setStorageConfigurations(IResolvable value) `AWS::M2::Environment.StorageConfigurations`.
void	setStorageConfigurations(List<Object> value) `AWS::M2::Environment.StorageConfigurations`.
void	setSubnetIds(List<String> value) `AWS::M2::Environment.SubnetIds`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnEnvironment

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

CfnEnvironment

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

CfnEnvironment

@Stability(value=Stable)
public CfnEnvironment(@NotNull
                                               software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrEnvironmentArn()

getAttrEnvironmentId

@Stability(value=Stable)
 @NotNull
public String getAttrEnvironmentId()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::M2::Environment.Tags`.

getEngineType

@Stability(value=Stable)
 @NotNull
public String getEngineType()

`AWS::M2::Environment.EngineType`.

setEngineType

@Stability(value=Stable)
public void setEngineType(@NotNull
                                                   String value)

`AWS::M2::Environment.EngineType`.

getInstanceType

@Stability(value=Stable)
 @NotNull
public String getInstanceType()

`AWS::M2::Environment.InstanceType`.

setInstanceType

@Stability(value=Stable)
public void setInstanceType(@NotNull
                                                     String value)

`AWS::M2::Environment.InstanceType`.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

`AWS::M2::Environment.Name`.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

`AWS::M2::Environment.Name`.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

`AWS::M2::Environment.Description`.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

`AWS::M2::Environment.Description`.

getEngineVersion

@Stability(value=Stable)
 @Nullable
public String getEngineVersion()

`AWS::M2::Environment.EngineVersion`.

setEngineVersion

@Stability(value=Stable)
public void setEngineVersion(@Nullable
                                                      String value)

`AWS::M2::Environment.EngineVersion`.

getHighAvailabilityConfig

@Stability(value=Stable)
 @Nullable
public Object getHighAvailabilityConfig()

`AWS::M2::Environment.HighAvailabilityConfig`.

setHighAvailabilityConfig

@Stability(value=Stable)
public void setHighAvailabilityConfig(@Nullable
                                                               CfnEnvironment.HighAvailabilityConfigProperty value)

`AWS::M2::Environment.HighAvailabilityConfig`.

setHighAvailabilityConfig

@Stability(value=Stable)
public void setHighAvailabilityConfig(@Nullable
                                                               IResolvable value)

`AWS::M2::Environment.HighAvailabilityConfig`.

getPreferredMaintenanceWindow

@Stability(value=Stable)
 @Nullable
public String getPreferredMaintenanceWindow()

`AWS::M2::Environment.PreferredMaintenanceWindow`.

setPreferredMaintenanceWindow

@Stability(value=Stable)
public void setPreferredMaintenanceWindow(@Nullable
                                                                   String value)

`AWS::M2::Environment.PreferredMaintenanceWindow`.

getPubliclyAccessible

@Stability(value=Stable)
 @Nullable
public Object getPubliclyAccessible()

`AWS::M2::Environment.PubliclyAccessible`.

setPubliclyAccessible

@Stability(value=Stable)
public void setPubliclyAccessible(@Nullable
                                                           Boolean value)

`AWS::M2::Environment.PubliclyAccessible`.

setPubliclyAccessible

@Stability(value=Stable)
public void setPubliclyAccessible(@Nullable
                                                           IResolvable value)

`AWS::M2::Environment.PubliclyAccessible`.

getSecurityGroupIds

@Stability(value=Stable)
 @Nullable
public List<String> getSecurityGroupIds()

`AWS::M2::Environment.SecurityGroupIds`.

setSecurityGroupIds

@Stability(value=Stable)
public void setSecurityGroupIds(@Nullable
                                                         List<String> value)

`AWS::M2::Environment.SecurityGroupIds`.

getStorageConfigurations

@Stability(value=Stable)
 @Nullable
public Object getStorageConfigurations()

`AWS::M2::Environment.StorageConfigurations`.

setStorageConfigurations

@Stability(value=Stable)
public void setStorageConfigurations(@Nullable
                                                              List<Object> value)

`AWS::M2::Environment.StorageConfigurations`.

setStorageConfigurations

@Stability(value=Stable)
public void setStorageConfigurations(@Nullable
                                                              IResolvable value)

`AWS::M2::Environment.StorageConfigurations`.

getSubnetIds

@Stability(value=Stable)
 @Nullable
public List<String> getSubnetIds()

`AWS::M2::Environment.SubnetIds`.

setSubnetIds

@Stability(value=Stable)
public void setSubnetIds(@Nullable
                                                  List<String> value)

`AWS::M2::Environment.SubnetIds`.