com.amazonaws.services.mainframemodernization.model

Class CreateEnvironmentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.mainframemodernization.model.CreateEnvironmentRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateEnvironmentRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateEnvironmentRequest()

Method Summary

Modifier and Type	Method and Description
CreateEnvironmentRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateEnvironmentRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateEnvironmentRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment.
String	getDescription() The description of the runtime environment.
String	getEngineType() The engine type for the runtime environment.
String	getEngineVersion() The version of the engine type for the runtime environment.
HighAvailabilityConfig	getHighAvailabilityConfig() The details of a high availability configuration for this runtime environment.
String	getInstanceType() The type of instance for the runtime environment.
String	getKmsKeyId() The identifier of a customer managed key.
String	getName() The name of the runtime environment.
String	getPreferredMaintenanceWindow() Configures the maintenance window that you want for the runtime environment.
Boolean	getPubliclyAccessible() Specifies whether the runtime environment is publicly accessible.
List<String>	getSecurityGroupIds() The list of security groups for the VPC associated with this runtime environment.
List<StorageConfiguration>	getStorageConfigurations() Optional.
List<String>	getSubnetIds() The list of subnets associated with the VPC for this runtime environment.
Map<String,String>	getTags() The tags for the runtime environment.
int	hashCode()
Boolean	isPubliclyAccessible() Specifies whether the runtime environment is publicly accessible.
void	setClientToken(String clientToken) Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment.
void	setDescription(String description) The description of the runtime environment.
void	setEngineType(String engineType) The engine type for the runtime environment.
void	setEngineVersion(String engineVersion) The version of the engine type for the runtime environment.
void	setHighAvailabilityConfig(HighAvailabilityConfig highAvailabilityConfig) The details of a high availability configuration for this runtime environment.
void	setInstanceType(String instanceType) The type of instance for the runtime environment.
void	setKmsKeyId(String kmsKeyId) The identifier of a customer managed key.
void	setName(String name) The name of the runtime environment.
void	setPreferredMaintenanceWindow(String preferredMaintenanceWindow) Configures the maintenance window that you want for the runtime environment.
void	setPubliclyAccessible(Boolean publiclyAccessible) Specifies whether the runtime environment is publicly accessible.
void	setSecurityGroupIds(Collection<String> securityGroupIds) The list of security groups for the VPC associated with this runtime environment.
void	setStorageConfigurations(Collection<StorageConfiguration> storageConfigurations) Optional.
void	setSubnetIds(Collection<String> subnetIds) The list of subnets associated with the VPC for this runtime environment.
void	setTags(Map<String,String> tags) The tags for the runtime environment.
String	toString() Returns a string representation of this object.
CreateEnvironmentRequest	withClientToken(String clientToken) Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment.
CreateEnvironmentRequest	withDescription(String description) The description of the runtime environment.
CreateEnvironmentRequest	withEngineType(EngineType engineType) The engine type for the runtime environment.
CreateEnvironmentRequest	withEngineType(String engineType) The engine type for the runtime environment.
CreateEnvironmentRequest	withEngineVersion(String engineVersion) The version of the engine type for the runtime environment.
CreateEnvironmentRequest	withHighAvailabilityConfig(HighAvailabilityConfig highAvailabilityConfig) The details of a high availability configuration for this runtime environment.
CreateEnvironmentRequest	withInstanceType(String instanceType) The type of instance for the runtime environment.
CreateEnvironmentRequest	withKmsKeyId(String kmsKeyId) The identifier of a customer managed key.
CreateEnvironmentRequest	withName(String name) The name of the runtime environment.
CreateEnvironmentRequest	withPreferredMaintenanceWindow(String preferredMaintenanceWindow) Configures the maintenance window that you want for the runtime environment.
CreateEnvironmentRequest	withPubliclyAccessible(Boolean publiclyAccessible) Specifies whether the runtime environment is publicly accessible.
CreateEnvironmentRequest	withSecurityGroupIds(Collection<String> securityGroupIds) The list of security groups for the VPC associated with this runtime environment.
CreateEnvironmentRequest	withSecurityGroupIds(String... securityGroupIds) The list of security groups for the VPC associated with this runtime environment.
CreateEnvironmentRequest	withStorageConfigurations(Collection<StorageConfiguration> storageConfigurations) Optional.
CreateEnvironmentRequest	withStorageConfigurations(StorageConfiguration... storageConfigurations) Optional.
CreateEnvironmentRequest	withSubnetIds(Collection<String> subnetIds) The list of subnets associated with the VPC for this runtime environment.
CreateEnvironmentRequest	withSubnetIds(String... subnetIds) The list of subnets associated with the VPC for this runtime environment.
CreateEnvironmentRequest	withTags(Map<String,String> tags) The tags for the runtime environment.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateEnvironmentRequest

public CreateEnvironmentRequest()

Method Detail

setClientToken

public void setClientToken(String clientToken)

Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

Parameters:

clientToken - Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

getClientToken

public String getClientToken()

Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

Returns:

Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

withClientToken

public CreateEnvironmentRequest withClientToken(String clientToken)

Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

Parameters:

clientToken - Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

The description of the runtime environment.

Parameters:

description - The description of the runtime environment.

getDescription

public String getDescription()

The description of the runtime environment.

Returns:

The description of the runtime environment.

withDescription

public CreateEnvironmentRequest withDescription(String description)

The description of the runtime environment.

Parameters:

description - The description of the runtime environment.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEngineType

public void setEngineType(String engineType)

The engine type for the runtime environment.

Parameters:

engineType - The engine type for the runtime environment.

See Also:

EngineType

getEngineType

public String getEngineType()

The engine type for the runtime environment.

Returns:

The engine type for the runtime environment.

See Also:

EngineType

withEngineType

public CreateEnvironmentRequest withEngineType(String engineType)

The engine type for the runtime environment.

Parameters:

engineType - The engine type for the runtime environment.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EngineType

withEngineType

public CreateEnvironmentRequest withEngineType(EngineType engineType)

The engine type for the runtime environment.

Parameters:

engineType - The engine type for the runtime environment.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EngineType

setEngineVersion

public void setEngineVersion(String engineVersion)

The version of the engine type for the runtime environment.

Parameters:

engineVersion - The version of the engine type for the runtime environment.

getEngineVersion

public String getEngineVersion()

The version of the engine type for the runtime environment.

Returns:

The version of the engine type for the runtime environment.

withEngineVersion

public CreateEnvironmentRequest withEngineVersion(String engineVersion)

The version of the engine type for the runtime environment.

Parameters:

engineVersion - The version of the engine type for the runtime environment.

Returns:

Returns a reference to this object so that method calls can be chained together.

setHighAvailabilityConfig

public void setHighAvailabilityConfig(HighAvailabilityConfig highAvailabilityConfig)

The details of a high availability configuration for this runtime environment.

Parameters:

highAvailabilityConfig - The details of a high availability configuration for this runtime environment.

getHighAvailabilityConfig

public HighAvailabilityConfig getHighAvailabilityConfig()

The details of a high availability configuration for this runtime environment.

Returns:

The details of a high availability configuration for this runtime environment.

withHighAvailabilityConfig

public CreateEnvironmentRequest withHighAvailabilityConfig(HighAvailabilityConfig highAvailabilityConfig)

The details of a high availability configuration for this runtime environment.

Parameters:

highAvailabilityConfig - The details of a high availability configuration for this runtime environment.

Returns:

Returns a reference to this object so that method calls can be chained together.

setInstanceType

public void setInstanceType(String instanceType)

The type of instance for the runtime environment.

Parameters:

instanceType - The type of instance for the runtime environment.

getInstanceType

public String getInstanceType()

The type of instance for the runtime environment.

Returns:

The type of instance for the runtime environment.

withInstanceType

public CreateEnvironmentRequest withInstanceType(String instanceType)

The type of instance for the runtime environment.

Parameters:

instanceType - The type of instance for the runtime environment.

Returns:

Returns a reference to this object so that method calls can be chained together.

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

The identifier of a customer managed key.

Parameters:

kmsKeyId - The identifier of a customer managed key.

getKmsKeyId

public String getKmsKeyId()

The identifier of a customer managed key.

Returns:

The identifier of a customer managed key.

withKmsKeyId

public CreateEnvironmentRequest withKmsKeyId(String kmsKeyId)

The identifier of a customer managed key.

Parameters:

kmsKeyId - The identifier of a customer managed key.

Returns:

Returns a reference to this object so that method calls can be chained together.

setName

public void setName(String name)

The name of the runtime environment. Must be unique within the account.

Parameters:

name - The name of the runtime environment. Must be unique within the account.

getName

public String getName()

The name of the runtime environment. Must be unique within the account.

Returns:

The name of the runtime environment. Must be unique within the account.

withName

public CreateEnvironmentRequest withName(String name)

The name of the runtime environment. Must be unique within the account.

Parameters:

name - The name of the runtime environment. Must be unique within the account.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPreferredMaintenanceWindow

public void setPreferredMaintenanceWindow(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. 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.

getPreferredMaintenanceWindow

public 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.

Returns:

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.

withPreferredMaintenanceWindow

public CreateEnvironmentRequest withPreferredMaintenanceWindow(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. 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPubliclyAccessible

public void setPubliclyAccessible(Boolean publiclyAccessible)

Specifies whether the runtime environment is publicly accessible.

Parameters:

publiclyAccessible - Specifies whether the runtime environment is publicly accessible.

getPubliclyAccessible

public Boolean getPubliclyAccessible()

Specifies whether the runtime environment is publicly accessible.

Returns:

Specifies whether the runtime environment is publicly accessible.

withPubliclyAccessible

public CreateEnvironmentRequest withPubliclyAccessible(Boolean publiclyAccessible)

Specifies whether the runtime environment is publicly accessible.

Parameters:

publiclyAccessible - Specifies whether the runtime environment is publicly accessible.

Returns:

Returns a reference to this object so that method calls can be chained together.

isPubliclyAccessible

public Boolean isPubliclyAccessible()

Specifies whether the runtime environment is publicly accessible.

Returns:

Specifies whether the runtime environment is publicly accessible.

getSecurityGroupIds

public List<String> getSecurityGroupIds()

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

Returns:

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

setSecurityGroupIds

public void setSecurityGroupIds(Collection<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.

withSecurityGroupIds

public CreateEnvironmentRequest withSecurityGroupIds(String... securityGroupIds)

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

NOTE: This method appends the values to the existing list (if any). Use setSecurityGroupIds(java.util.Collection) or withSecurityGroupIds(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withSecurityGroupIds

public CreateEnvironmentRequest withSecurityGroupIds(Collection<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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getStorageConfigurations

public List<StorageConfiguration> getStorageConfigurations()

Optional. The storage configurations for this runtime environment.

Returns:

Optional. The storage configurations for this runtime environment.

setStorageConfigurations

public void setStorageConfigurations(Collection<StorageConfiguration> storageConfigurations)

Optional. The storage configurations for this runtime environment.

Parameters:

storageConfigurations - Optional. The storage configurations for this runtime environment.

withStorageConfigurations

public CreateEnvironmentRequest withStorageConfigurations(StorageConfiguration... storageConfigurations)

Optional. The storage configurations for this runtime environment.

NOTE: This method appends the values to the existing list (if any). Use setStorageConfigurations(java.util.Collection) or withStorageConfigurations(java.util.Collection) if you want to override the existing values.

Parameters:

storageConfigurations - Optional. The storage configurations for this runtime environment.

Returns:

Returns a reference to this object so that method calls can be chained together.

withStorageConfigurations

public CreateEnvironmentRequest withStorageConfigurations(Collection<StorageConfiguration> storageConfigurations)

Optional. The storage configurations for this runtime environment.

Parameters:

storageConfigurations - Optional. The storage configurations for this runtime environment.

Returns:

Returns a reference to this object so that method calls can be chained together.

getSubnetIds

public List<String> getSubnetIds()

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

Returns:

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

setSubnetIds

public void setSubnetIds(Collection<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.

withSubnetIds

public CreateEnvironmentRequest withSubnetIds(String... subnetIds)

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

NOTE: This method appends the values to the existing list (if any). Use setSubnetIds(java.util.Collection) or withSubnetIds(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withSubnetIds

public CreateEnvironmentRequest withSubnetIds(Collection<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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public Map<String,String> getTags()

The tags for the runtime environment.

Returns:

The tags for the runtime environment.

setTags

public void setTags(Map<String,String> tags)

The tags for the runtime environment.

Parameters:

tags - The tags for the runtime environment.

withTags

public CreateEnvironmentRequest withTags(Map<String,String> tags)

The tags for the runtime environment.

Parameters:

tags - The tags for the runtime environment.

Returns:

Returns a reference to this object so that method calls can be chained together.

addTagsEntry

public CreateEnvironmentRequest addTagsEntry(String key,
                                             String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateEnvironmentRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateEnvironmentRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()