Class: Aws::S3::Types::Redirect

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass Redirect data as a hash:

{
  host_name: "HostName",
  http_redirect_code: "HttpRedirectCode",
  protocol: "http", # accepts http, https
  replace_key_prefix_with: "ReplaceKeyPrefixWith",
  replace_key_with: "ReplaceKeyWith",
}

Specifies how requests are redirected. In the event of an error, you can specify a different error code to return.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#host_nameString

The host name to use in the redirect request.

Returns:

  • (String)


14413
14414
14415
14416
14417
14418
14419
14420
14421
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 14413

class Redirect < Struct.new(
  :host_name,
  :http_redirect_code,
  :protocol,
  :replace_key_prefix_with,
  :replace_key_with)
  SENSITIVE = []
  include Aws::Structure
end

#http_redirect_codeString

The HTTP redirect code to use on the response. Not required if one of the siblings is present.

Returns:

  • (String)


14413
14414
14415
14416
14417
14418
14419
14420
14421
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 14413

class Redirect < Struct.new(
  :host_name,
  :http_redirect_code,
  :protocol,
  :replace_key_prefix_with,
  :replace_key_with)
  SENSITIVE = []
  include Aws::Structure
end

#protocolString

Protocol to use when redirecting requests. The default is the protocol that is used in the original request.

Returns:

  • (String)


14413
14414
14415
14416
14417
14418
14419
14420
14421
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 14413

class Redirect < Struct.new(
  :host_name,
  :http_redirect_code,
  :protocol,
  :replace_key_prefix_with,
  :replace_key_with)
  SENSITIVE = []
  include Aws::Structure
end

#replace_key_prefix_withString

The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

Returns:

  • (String)


14413
14414
14415
14416
14417
14418
14419
14420
14421
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 14413

class Redirect < Struct.new(
  :host_name,
  :http_redirect_code,
  :protocol,
  :replace_key_prefix_with,
  :replace_key_with)
  SENSITIVE = []
  include Aws::Structure
end

#replace_key_withString

The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the siblings is present. Can be present only if ReplaceKeyPrefixWith is not provided.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

Returns:

  • (String)


14413
14414
14415
14416
14417
14418
14419
14420
14421
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 14413

class Redirect < Struct.new(
  :host_name,
  :http_redirect_code,
  :protocol,
  :replace_key_prefix_with,
  :replace_key_with)
  SENSITIVE = []
  include Aws::Structure
end