Struct aws_sdk_s3::model::Redirect

#[non_exhaustive]
pub struct Redirect {
    pub host_name: Option<String>,
    pub http_redirect_code: Option<String>,
    pub protocol: Option<Protocol>,
    pub replace_key_prefix_with: Option<String>,
    pub replace_key_with: Option<String>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

host_name: Option<String>

The host name to use in the redirect request.

http_redirect_code: Option<String>

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

protocol: Option<Protocol>

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

replace_key_prefix_with: Option<String>

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.

replace_key_with: Option<String>

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.

Implementations

impl Redirect

pub fn host_name(&self) -> Option<&str>

The host name to use in the redirect request.

pub fn http_redirect_code(&self) -> Option<&str>

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

pub fn protocol(&self) -> Option<&Protocol>

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

pub fn replace_key_prefix_with(&self) -> Option<&str>

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.

pub fn replace_key_with(&self) -> Option<&str>

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.

impl Redirect

pub fn builder() -> Builder

Creates a new builder-style object to manufacture Redirect

Trait Implementations

impl Clone for Redirect

fn clone(&self) -> Redirect

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Redirect

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<Redirect> for Redirect

fn eq(&self, other: &Redirect) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Redirect) -> bool

This method tests for !=.

impl StructuralPartialEq for Redirect