com.amazonaws.services.workspacesthinclient.model

Class CreateEnvironmentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.workspacesthinclient.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	addDeviceCreationTagsEntry(String key, String value) Add a single DeviceCreationTags entry
CreateEnvironmentRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateEnvironmentRequest	clearDeviceCreationTagsEntries() Removes all the entries added into DeviceCreationTags.
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() Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	getDesiredSoftwareSetId() The ID of the software set to apply.
String	getDesktopArn() The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
String	getDesktopEndpoint() The URL for the identity provider login (only for environments that use AppStream 2.0).
Map<String,String>	getDeviceCreationTags() A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.
String	getKmsKeyArn() The Amazon Resource Name (ARN) of the Key Management Service key to use to encrypt the environment.
MaintenanceWindow	getMaintenanceWindow() A specification for a time window to apply software updates.
String	getName() The name for the environment.
String	getSoftwareSetUpdateMode() An option to define which software updates to apply.
String	getSoftwareSetUpdateSchedule() An option to define if software updates should be applied within a maintenance window.
Map<String,String>	getTags() A map of the key-value pairs of the tag or tags to assign to the resource.
int	hashCode()
void	setClientToken(String clientToken) Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
void	setDesiredSoftwareSetId(String desiredSoftwareSetId) The ID of the software set to apply.
void	setDesktopArn(String desktopArn) The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
void	setDesktopEndpoint(String desktopEndpoint) The URL for the identity provider login (only for environments that use AppStream 2.0).
void	setDeviceCreationTags(Map<String,String> deviceCreationTags) A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.
void	setKmsKeyArn(String kmsKeyArn) The Amazon Resource Name (ARN) of the Key Management Service key to use to encrypt the environment.
void	setMaintenanceWindow(MaintenanceWindow maintenanceWindow) A specification for a time window to apply software updates.
void	setName(String name) The name for the environment.
void	setSoftwareSetUpdateMode(String softwareSetUpdateMode) An option to define which software updates to apply.
void	setSoftwareSetUpdateSchedule(String softwareSetUpdateSchedule) An option to define if software updates should be applied within a maintenance window.
void	setTags(Map<String,String> tags) A map of the key-value pairs of the tag or tags to assign to the resource.
String	toString() Returns a string representation of this object.
CreateEnvironmentRequest	withClientToken(String clientToken) Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreateEnvironmentRequest	withDesiredSoftwareSetId(String desiredSoftwareSetId) The ID of the software set to apply.
CreateEnvironmentRequest	withDesktopArn(String desktopArn) The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
CreateEnvironmentRequest	withDesktopEndpoint(String desktopEndpoint) The URL for the identity provider login (only for environments that use AppStream 2.0).
CreateEnvironmentRequest	withDeviceCreationTags(Map<String,String> deviceCreationTags) A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.
CreateEnvironmentRequest	withKmsKeyArn(String kmsKeyArn) The Amazon Resource Name (ARN) of the Key Management Service key to use to encrypt the environment.
CreateEnvironmentRequest	withMaintenanceWindow(MaintenanceWindow maintenanceWindow) A specification for a time window to apply software updates.
CreateEnvironmentRequest	withName(String name) The name for the environment.
CreateEnvironmentRequest	withSoftwareSetUpdateMode(SoftwareSetUpdateMode softwareSetUpdateMode) An option to define which software updates to apply.
CreateEnvironmentRequest	withSoftwareSetUpdateMode(String softwareSetUpdateMode) An option to define which software updates to apply.
CreateEnvironmentRequest	withSoftwareSetUpdateSchedule(SoftwareSetUpdateSchedule softwareSetUpdateSchedule) An option to define if software updates should be applied within a maintenance window.
CreateEnvironmentRequest	withSoftwareSetUpdateSchedule(String softwareSetUpdateSchedule) An option to define if software updates should be applied within a maintenance window.
CreateEnvironmentRequest	withTags(Map<String,String> tags) A map of the key-value pairs of the tag or tags to assign to the resource.

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

setName

public void setName(String name)

The name for the environment.

Parameters:

name - The name for the environment.

getName

public String getName()

The name for the environment.

Returns:

The name for the environment.

withName

public CreateEnvironmentRequest withName(String name)

The name for the environment.

Parameters:

name - The name for the environment.

Returns:

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

setDesktopArn

public void setDesktopArn(String desktopArn)

The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.

Parameters:

desktopArn - The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.

getDesktopArn

public String getDesktopArn()

The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.

Returns:

The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.

withDesktopArn

public CreateEnvironmentRequest withDesktopArn(String desktopArn)

The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.

Parameters:

desktopArn - The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.

Returns:

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

setDesktopEndpoint

public void setDesktopEndpoint(String desktopEndpoint)

The URL for the identity provider login (only for environments that use AppStream 2.0).

Parameters:

desktopEndpoint - The URL for the identity provider login (only for environments that use AppStream 2.0).

getDesktopEndpoint

public String getDesktopEndpoint()

The URL for the identity provider login (only for environments that use AppStream 2.0).

Returns:

The URL for the identity provider login (only for environments that use AppStream 2.0).

withDesktopEndpoint

public CreateEnvironmentRequest withDesktopEndpoint(String desktopEndpoint)

The URL for the identity provider login (only for environments that use AppStream 2.0).

Parameters:

desktopEndpoint - The URL for the identity provider login (only for environments that use AppStream 2.0).

Returns:

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

setSoftwareSetUpdateSchedule

public void setSoftwareSetUpdateSchedule(String softwareSetUpdateSchedule)

An option to define if software updates should be applied within a maintenance window.

Parameters:

softwareSetUpdateSchedule - An option to define if software updates should be applied within a maintenance window.

See Also:

SoftwareSetUpdateSchedule

getSoftwareSetUpdateSchedule

public String getSoftwareSetUpdateSchedule()

An option to define if software updates should be applied within a maintenance window.

Returns:

An option to define if software updates should be applied within a maintenance window.

See Also:

SoftwareSetUpdateSchedule

withSoftwareSetUpdateSchedule

public CreateEnvironmentRequest withSoftwareSetUpdateSchedule(String softwareSetUpdateSchedule)

An option to define if software updates should be applied within a maintenance window.

Parameters:

softwareSetUpdateSchedule - An option to define if software updates should be applied within a maintenance window.

Returns:

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

See Also:

SoftwareSetUpdateSchedule

withSoftwareSetUpdateSchedule

public CreateEnvironmentRequest withSoftwareSetUpdateSchedule(SoftwareSetUpdateSchedule softwareSetUpdateSchedule)

An option to define if software updates should be applied within a maintenance window.

Parameters:

softwareSetUpdateSchedule - An option to define if software updates should be applied within a maintenance window.

Returns:

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

See Also:

SoftwareSetUpdateSchedule

setMaintenanceWindow

public void setMaintenanceWindow(MaintenanceWindow maintenanceWindow)

A specification for a time window to apply software updates.

Parameters:

maintenanceWindow - A specification for a time window to apply software updates.

getMaintenanceWindow

public MaintenanceWindow getMaintenanceWindow()

A specification for a time window to apply software updates.

Returns:

A specification for a time window to apply software updates.

withMaintenanceWindow

public CreateEnvironmentRequest withMaintenanceWindow(MaintenanceWindow maintenanceWindow)

A specification for a time window to apply software updates.

Parameters:

maintenanceWindow - A specification for a time window to apply software updates.

Returns:

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

setSoftwareSetUpdateMode

public void setSoftwareSetUpdateMode(String softwareSetUpdateMode)

An option to define which software updates to apply.

Parameters:

softwareSetUpdateMode - An option to define which software updates to apply.

See Also:

SoftwareSetUpdateMode

getSoftwareSetUpdateMode

public String getSoftwareSetUpdateMode()

An option to define which software updates to apply.

Returns:

An option to define which software updates to apply.

See Also:

SoftwareSetUpdateMode

withSoftwareSetUpdateMode

public CreateEnvironmentRequest withSoftwareSetUpdateMode(String softwareSetUpdateMode)

An option to define which software updates to apply.

Parameters:

softwareSetUpdateMode - An option to define which software updates to apply.

Returns:

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

See Also:

SoftwareSetUpdateMode

withSoftwareSetUpdateMode

public CreateEnvironmentRequest withSoftwareSetUpdateMode(SoftwareSetUpdateMode softwareSetUpdateMode)

An option to define which software updates to apply.

Parameters:

softwareSetUpdateMode - An option to define which software updates to apply.

Returns:

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

See Also:

SoftwareSetUpdateMode

setDesiredSoftwareSetId

public void setDesiredSoftwareSetId(String desiredSoftwareSetId)

The ID of the software set to apply.

Parameters:

desiredSoftwareSetId - The ID of the software set to apply.

getDesiredSoftwareSetId

public String getDesiredSoftwareSetId()

The ID of the software set to apply.

Returns:

The ID of the software set to apply.

withDesiredSoftwareSetId

public CreateEnvironmentRequest withDesiredSoftwareSetId(String desiredSoftwareSetId)

The ID of the software set to apply.

Parameters:

desiredSoftwareSetId - The ID of the software set to apply.

Returns:

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

setKmsKeyArn

public void setKmsKeyArn(String kmsKeyArn)

The Amazon Resource Name (ARN) of the Key Management Service key to use to encrypt the environment.

Parameters:

kmsKeyArn - The Amazon Resource Name (ARN) of the Key Management Service key to use to encrypt the environment.

getKmsKeyArn

public String getKmsKeyArn()

The Amazon Resource Name (ARN) of the Key Management Service key to use to encrypt the environment.

Returns:

The Amazon Resource Name (ARN) of the Key Management Service key to use to encrypt the environment.

withKmsKeyArn

public CreateEnvironmentRequest withKmsKeyArn(String kmsKeyArn)

The Amazon Resource Name (ARN) of the Key Management Service key to use to encrypt the environment.

Parameters:

kmsKeyArn - The Amazon Resource Name (ARN) of the Key Management Service key to use to encrypt the environment.

Returns:

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

setClientToken

public void setClientToken(String clientToken)

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

Parameters:

clientToken - Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

getClientToken

public String getClientToken()

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

Returns:

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

withClientToken

public CreateEnvironmentRequest withClientToken(String clientToken)

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

Parameters:

clientToken - Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

Returns:

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

getTags

public Map<String,String> getTags()

A map of the key-value pairs of the tag or tags to assign to the resource.

Returns:

A map of the key-value pairs of the tag or tags to assign to the resource.

setTags

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

A map of the key-value pairs of the tag or tags to assign to the resource.

Parameters:

tags - A map of the key-value pairs of the tag or tags to assign to the resource.

withTags

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

A map of the key-value pairs of the tag or tags to assign to the resource.

Parameters:

tags - A map of the key-value pairs of the tag or tags to assign to the resource.

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.

getDeviceCreationTags

public Map<String,String> getDeviceCreationTags()

A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.

Returns:

A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.

setDeviceCreationTags

public void setDeviceCreationTags(Map<String,String> deviceCreationTags)

A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.

Parameters:

deviceCreationTags - A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.

withDeviceCreationTags

public CreateEnvironmentRequest withDeviceCreationTags(Map<String,String> deviceCreationTags)

A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.

Parameters:

deviceCreationTags - A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.

Returns:

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

addDeviceCreationTagsEntry

public CreateEnvironmentRequest addDeviceCreationTagsEntry(String key,
                                                           String value)

Add a single DeviceCreationTags entry

See Also:

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

clearDeviceCreationTagsEntries

public CreateEnvironmentRequest clearDeviceCreationTagsEntries()

Removes all the entries added into DeviceCreationTags.

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()