CreateEnvironmentRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.finspace.model

Class CreateEnvironmentRequest

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.finspace.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 ()

Constructors
Constructor and Description
`CreateEnvironmentRequest ()`

Method Summary

All Methods
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)`
`List<String>`	`getDataBundles ()` The list of Amazon Resource Names (ARN) of the data bundles to install.
`String`	`getDescription ()` The description of the FinSpace environment to be created.
`String`	`getFederationMode ()` Authentication mode for the environment.
`FederationParameters`	`getFederationParameters ()` Configuration information when authentication mode is FEDERATED.
`String`	`getKmsKeyId ()` The KMS key id to encrypt your data in the FinSpace environment.
`String`	`getName ()` The name of the FinSpace environment to be created.
`SuperuserParameters`	`getSuperuserParameters ()` Configuration information for the superuser.
`Map<String,String>`	`getTags ()` Add tags to your FinSpace environment.
`int`	`hashCode ()`
`void`	`setDataBundles (Collection<String> dataBundles)` The list of Amazon Resource Names (ARN) of the data bundles to install.
`void`	`setDescription (String description)` The description of the FinSpace environment to be created.
`void`	`setFederationMode (String federationMode)` Authentication mode for the environment.
`void`	`setFederationParameters (FederationParameters federationParameters)` Configuration information when authentication mode is FEDERATED.
`void`	`setKmsKeyId (String kmsKeyId)` The KMS key id to encrypt your data in the FinSpace environment.
`void`	`setName (String name)` The name of the FinSpace environment to be created.
`void`	`setSuperuserParameters (SuperuserParameters superuserParameters)` Configuration information for the superuser.
`void`	`setTags (Map<String,String> tags)` Add tags to your FinSpace environment.
`String`	`toString ()` Returns a string representation of this object.
`CreateEnvironmentRequest`	`withDataBundles (Collection<String> dataBundles)` The list of Amazon Resource Names (ARN) of the data bundles to install.
`CreateEnvironmentRequest`	`withDataBundles (String... dataBundles)` The list of Amazon Resource Names (ARN) of the data bundles to install.
`CreateEnvironmentRequest`	`withDescription (String description)` The description of the FinSpace environment to be created.
`CreateEnvironmentRequest`	`withFederationMode (FederationMode federationMode)` Authentication mode for the environment.
`CreateEnvironmentRequest`	`withFederationMode (String federationMode)` Authentication mode for the environment.
`CreateEnvironmentRequest`	`withFederationParameters (FederationParameters federationParameters)` Configuration information when authentication mode is FEDERATED.
`CreateEnvironmentRequest`	`withKmsKeyId (String kmsKeyId)` The KMS key id to encrypt your data in the FinSpace environment.
`CreateEnvironmentRequest`	`withName (String name)` The name of the FinSpace environment to be created.
`CreateEnvironmentRequest`	`withSuperuserParameters (SuperuserParameters superuserParameters)` Configuration information for the superuser.
`CreateEnvironmentRequest`	`withTags (Map<String,String> tags)` Add tags to your FinSpace 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
  - setName
```
public void setName(String name)
```
    The name of the FinSpace environment to be created.
    
    Parameters:
    
    name - The name of the FinSpace environment to be created.
  - getName
```
public String getName()
```
    The name of the FinSpace environment to be created.
    
    Returns:
    
    The name of the FinSpace environment to be created.
  - withName
```
public CreateEnvironmentRequest withName(String name)
```
    The name of the FinSpace environment to be created.
    
    Parameters:
    
    name - The name of the FinSpace environment to be created.
    
    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 FinSpace environment to be created.
    
    Parameters:
    
    description - The description of the FinSpace environment to be created.
  - getDescription
```
public String getDescription()
```
    The description of the FinSpace environment to be created.
    
    Returns:
    
    The description of the FinSpace environment to be created.
  - withDescription
```
public CreateEnvironmentRequest withDescription(String description)
```
    The description of the FinSpace environment to be created.
    
    Parameters:
    
    description - The description of the FinSpace environment to be created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKmsKeyId
```
public void setKmsKeyId(String kmsKeyId)
```
    The KMS key id to encrypt your data in the FinSpace environment.
    
    Parameters:
    
    kmsKeyId - The KMS key id to encrypt your data in the FinSpace environment.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    The KMS key id to encrypt your data in the FinSpace environment.
    
    Returns:
    
    The KMS key id to encrypt your data in the FinSpace environment.
  - withKmsKeyId
```
public CreateEnvironmentRequest withKmsKeyId(String kmsKeyId)
```
    The KMS key id to encrypt your data in the FinSpace environment.
    
    Parameters:
    
    kmsKeyId - The KMS key id to encrypt your data in the FinSpace environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    Add tags to your FinSpace environment.
    
    Returns:
    
    Add tags to your FinSpace environment.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    Add tags to your FinSpace environment.
    
    Parameters:
    
    tags - Add tags to your FinSpace environment.
  - withTags
```
public CreateEnvironmentRequest withTags(Map<String,String> tags)
```
    Add tags to your FinSpace environment.
    
    Parameters:
    
    tags - Add tags to your FinSpace 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.
  - setFederationMode
```
public void setFederationMode(String federationMode)
```
    Authentication mode for the environment.
    - FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.
    - LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.
    Parameters:
    federationMode - Authentication mode for the environment.
    
    FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.
    
    LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.
    See Also:
    
    FederationMode
  - getFederationMode
```
public String getFederationMode()
```
    Authentication mode for the environment.
    - FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.
    - LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.
    Returns:
    Authentication mode for the environment.
    
    FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.
    
    LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.
    See Also:
    
    FederationMode
  - withFederationMode
```
public CreateEnvironmentRequest withFederationMode(String federationMode)
```
    Authentication mode for the environment.
    - FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.
    - LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.
    Parameters:
    federationMode - Authentication mode for the environment.
    
    FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.
    
    LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FederationMode
  - withFederationMode
```
public CreateEnvironmentRequest withFederationMode(FederationMode federationMode)
```
    Authentication mode for the environment.
    - FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.
    - LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.
    Parameters:
    federationMode - Authentication mode for the environment.
    
    FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.
    
    LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FederationMode
  - setFederationParameters
```
public void setFederationParameters(FederationParameters federationParameters)
```
    Configuration information when authentication mode is FEDERATED.
    
    Parameters:
    
    federationParameters - Configuration information when authentication mode is FEDERATED.
  - getFederationParameters
```
public FederationParameters getFederationParameters()
```
    Configuration information when authentication mode is FEDERATED.
    
    Returns:
    
    Configuration information when authentication mode is FEDERATED.
  - withFederationParameters
```
public CreateEnvironmentRequest withFederationParameters(FederationParameters federationParameters)
```
    Configuration information when authentication mode is FEDERATED.
    
    Parameters:
    
    federationParameters - Configuration information when authentication mode is FEDERATED.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSuperuserParameters
```
public void setSuperuserParameters(SuperuserParameters superuserParameters)
```
    Configuration information for the superuser.
    
    Parameters:
    
    superuserParameters - Configuration information for the superuser.
  - getSuperuserParameters
```
public SuperuserParameters getSuperuserParameters()
```
    Configuration information for the superuser.
    
    Returns:
    
    Configuration information for the superuser.
  - withSuperuserParameters
```
public CreateEnvironmentRequest withSuperuserParameters(SuperuserParameters superuserParameters)
```
    Configuration information for the superuser.
    
    Parameters:
    
    superuserParameters - Configuration information for the superuser.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDataBundles
```
public List<String> getDataBundles()
```
    The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:
    - arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies.
    - arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.
    Returns:
    The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:
    
    arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies.
    
    arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.
  - setDataBundles
```
public void setDataBundles(Collection<String> dataBundles)
```
    The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:
    - arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies.
    - arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.
    Parameters:
    dataBundles - The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:
    
    arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies.
    
    arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.
  - withDataBundles
```
public CreateEnvironmentRequest withDataBundles(String... dataBundles)
```
    The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:
    - arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies.
    - arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.
    NOTE: This method appends the values to the existing list (if any). Use setDataBundles(java.util.Collection) or withDataBundles(java.util.Collection) if you want to override the existing values.
    Parameters:
    dataBundles - The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:
    
    arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies.
    
    arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDataBundles
```
public CreateEnvironmentRequest withDataBundles(Collection<String> dataBundles)
```
    The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:
    - arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies.
    - arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.
    Parameters:
    dataBundles - The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:
    
    arn:aws:finspace:${Region}::data-bundle/capital-markets-sample - Contains sample Capital Markets datasets, categories and controlled vocabularies.
    
    arn:aws:finspace:${Region}::data-bundle/taq (default) - Contains trades and quotes data in addition to sample Capital Markets data.
    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()

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class CreateEnvironmentRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateEnvironmentRequest

Method Detail

setName

getName

withName

setDescription

getDescription

withDescription

setKmsKeyId

getKmsKeyId

withKmsKeyId

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setFederationMode

getFederationMode

withFederationMode

withFederationMode

setFederationParameters

getFederationParameters

withFederationParameters

setSuperuserParameters

getSuperuserParameters

withSuperuserParameters

getDataBundles

setDataBundles

withDataBundles

withDataBundles

toString

equals

hashCode

clone