Interface ActivateGatewayRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ActivateGatewayRequest.Builder,ActivateGatewayRequest>, SdkBuilder<ActivateGatewayRequest.Builder,ActivateGatewayRequest>, SdkPojo, SdkRequest.Builder, StorageGatewayRequest.Builder
Enclosing class:
ActivateGatewayRequest
@Mutable @NotThreadSafe public static interface ActivateGatewayRequest.Builder extends StorageGatewayRequest.Builder, SdkPojo, CopyableBuilder<ActivateGatewayRequest.Builder,ActivateGatewayRequest>

  • Method Details

    • activationKey

      ActivateGatewayRequest.Builder activationKey(String activationKey)

      Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway.

      For more information, see Getting activation key in the Storage Gateway User Guide.

      Parameters:
      activationKey - Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway.

      For more information, see Getting activation key in the Storage Gateway User Guide.

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

    • gatewayName

      ActivateGatewayRequest.Builder gatewayName(String gatewayName)

      The name you configured for your gateway.

      Parameters:
      gatewayName - The name you configured for your gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gatewayTimezone

      ActivateGatewayRequest.Builder gatewayTimezone(String gatewayTimezone)

      A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT", "GMT-hr:mm", or "GMT+hr:mm". For example, GMT indicates Greenwich Mean Time without any offset. GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.

      Parameters:
      gatewayTimezone - A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT", "GMT-hr:mm", or "GMT+hr:mm". For example, GMT indicates Greenwich Mean Time without any offset. GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gatewayRegion

      ActivateGatewayRequest.Builder gatewayRegion(String gatewayRegion)

      A value that indicates the Amazon Web Services Region where you want to store your data. The gateway Amazon Web Services Region specified must be the same Amazon Web Services Region as the Amazon Web Services Region in your Host header in the request. For more information about available Amazon Web Services Regions and endpoints for Storage Gateway, see Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.

      Valid Values: See Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.

      Parameters:
      gatewayRegion - A value that indicates the Amazon Web Services Region where you want to store your data. The gateway Amazon Web Services Region specified must be the same Amazon Web Services Region as the Amazon Web Services Region in your Host header in the request. For more information about available Amazon Web Services Regions and endpoints for Storage Gateway, see Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.

      Valid Values: See Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.

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

    • gatewayType

      ActivateGatewayRequest.Builder gatewayType(String gatewayType)

      A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is CACHED.

      Amazon FSx File Gateway is no longer available to new customers. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit this blog post.

      Valid Values: STORED | CACHED | VTL | FILE_S3 | FILE_FSX_SMB

      Parameters:
      gatewayType - A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is CACHED.

      Amazon FSx File Gateway is no longer available to new customers. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit this blog post.

      Valid Values: STORED | CACHED | VTL | FILE_S3 | FILE_FSX_SMB

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

    • tapeDriveType

      ActivateGatewayRequest.Builder tapeDriveType(String tapeDriveType)

      The value that indicates the type of tape drive to use for tape gateway. This field is optional.

      Valid Values: IBM-ULT3580-TD5

      Parameters:
      tapeDriveType - The value that indicates the type of tape drive to use for tape gateway. This field is optional.

      Valid Values: IBM-ULT3580-TD5

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

    • mediumChangerType

      ActivateGatewayRequest.Builder mediumChangerType(String mediumChangerType)

      The value that indicates the type of medium changer to use for tape gateway. This field is optional.

      Valid Values: STK-L700 | AWS-Gateway-VTL | IBM-03584L32-0402

      Parameters:
      mediumChangerType - The value that indicates the type of medium changer to use for tape gateway. This field is optional.

      Valid Values: STK-L700 | AWS-Gateway-VTL | IBM-03584L32-0402

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

    • tags

      ActivateGatewayRequest.Builder tags(Collection<Tag> tags)

      A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.

      Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.

      Parameters:
      tags - A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.

      Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.

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

    • tags

      ActivateGatewayRequest.Builder tags(Tag... tags)

      A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.

      Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.

      Parameters:
      tags - A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.

      Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.

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

    • tags

      ActivateGatewayRequest.Builder tags(Consumer<Tag.Builder>... tags)

      A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.

      Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      ActivateGatewayRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ActivateGatewayRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.