Class DefaultWorkspaceCreationProperties

java.lang.Object
software.amazon.awssdk.services.workspaces.model.DefaultWorkspaceCreationProperties
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DefaultWorkspaceCreationProperties.Builder,DefaultWorkspaceCreationProperties>
@Generated("software.amazon.awssdk:codegen") public final class DefaultWorkspaceCreationProperties extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DefaultWorkspaceCreationProperties.Builder,DefaultWorkspaceCreationProperties>

Describes the default values that are used to create WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.

See Also:

  • Method Details

    • enableInternetAccess

      public final Boolean enableInternetAccess()

      Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an internet gateway in the Amazon VPC in which your WorkSpaces are located. If you're using a Network Address Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, see Configure a VPC for Amazon WorkSpaces.

      Returns:
      Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an internet gateway in the Amazon VPC in which your WorkSpaces are located. If you're using a Network Address Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, see Configure a VPC for Amazon WorkSpaces.

    • defaultOu

      public final String defaultOu()

      The organizational unit (OU) in the directory for the WorkSpace machine accounts.

      Returns:
      The organizational unit (OU) in the directory for the WorkSpace machine accounts.

    • customSecurityGroupId

      public final String customSecurityGroupId()

      The identifier of the default security group to apply to WorkSpaces when they are created. For more information, see Security Groups for Your WorkSpaces.

      Returns:
      The identifier of the default security group to apply to WorkSpaces when they are created. For more information, see Security Groups for Your WorkSpaces.

    • userEnabledAsLocalAdministrator

      public final Boolean userEnabledAsLocalAdministrator()

      Specifies whether WorkSpace users are local administrators on their WorkSpaces.

      Returns:
      Specifies whether WorkSpace users are local administrators on their WorkSpaces.

    • enableMaintenanceMode

      public final Boolean enableMaintenanceMode()

      Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see WorkSpace Maintenance.

      Returns:
      Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see WorkSpace Maintenance.

    • instanceIamRoleArn

      public final String instanceIamRoleArn()

      Indicates the IAM role ARN of the instance.

      Returns:
      Indicates the IAM role ARN of the instance.

    • toBuilder

      public DefaultWorkspaceCreationProperties.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<DefaultWorkspaceCreationProperties.Builder,DefaultWorkspaceCreationProperties>
      Returns:
      a builder for type T

    • builder

      public static DefaultWorkspaceCreationProperties.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.