Package software.amazon.awssdk.services.finspace.model

Class CreateEnvironmentRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.finspace.model.FinspaceRequest
software.amazon.awssdk.services.finspace.model.CreateEnvironmentRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateEnvironmentRequest extends FinspaceRequest implements ToCopyableBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>

  • Method Details

    • name

      public final String name()

      The name of the FinSpace environment to be created.

      Returns:
      The name of the FinSpace environment to be created.

    • description

      public final String description()

      The description of the FinSpace environment to be created.

      Returns:
      The description of the FinSpace environment to be created.

    • kmsKeyId

      public final String kmsKeyId()

      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.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()

      Add tags to your FinSpace environment.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      Add tags to your FinSpace environment.

    • federationMode

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

      If the service returns an enum value that is not available in the current SDK version, federationMode will return FederationMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from federationModeAsString().

      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:

    • federationModeAsString

      public final String federationModeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, federationMode will return FederationMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from federationModeAsString().

      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:

    • federationParameters

      public final FederationParameters federationParameters()

      Configuration information when authentication mode is FEDERATED.

      Returns:
      Configuration information when authentication mode is FEDERATED.

    • superuserParameters

      public final SuperuserParameters superuserParameters()

      Configuration information for the superuser.

      Returns:
      Configuration information for the superuser.

    • hasDataBundles

      public final boolean hasDataBundles()
      For responses, this returns true if the service returned a value for the DataBundles property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • dataBundles

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDataBundles() method.

      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.

    • toBuilder

      public CreateEnvironmentRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>
      Specified by:
      toBuilder in class FinspaceRequest
      Returns:
      a builder for type T

    • builder

      public static CreateEnvironmentRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateEnvironmentRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.