Struct aws_sdk_storagegateway::operation::describe_gateway_information::DescribeGatewayInformationOutput

#[non_exhaustive]
pub struct DescribeGatewayInformationOutput {

    pub gateway_arn: Option<String>,
    pub gateway_id: Option<String>,
    pub gateway_name: Option<String>,
    pub gateway_timezone: Option<String>,
    pub gateway_state: Option<String>,
    pub gateway_network_interfaces: Option<Vec<NetworkInterface>>,
    pub gateway_type: Option<String>,
    pub next_update_availability_date: Option<String>,
    pub last_software_update: Option<String>,
    pub ec2_instance_id: Option<String>,
    pub ec2_instance_region: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub vpc_endpoint: Option<String>,
    pub cloud_watch_log_group_arn: Option<String>,
    pub host_environment: Option<HostEnvironment>,
    pub endpoint_type: Option<String>,
    pub software_updates_end_date: Option<String>,
    pub deprecation_date: Option<String>,
    pub gateway_capacity: Option<GatewayCapacity>,
    pub supported_gateway_capacities: Option<Vec<GatewayCapacity>>,
    pub host_environment_id: Option<String>,
    pub software_version: Option<String>,
    /* private fields */
}

A JSON object containing the following fields:

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.

gateway_arn: Option<String>

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

gateway_id: Option<String>

The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

gateway_name: Option<String>

The name you configured for your gateway.

gateway_timezone: Option<String>

A value that indicates the time zone configured for the gateway.

gateway_state: Option<String>

A value that indicates the operating state of the gateway.

gateway_network_interfaces: Option<Vec<NetworkInterface>>

A NetworkInterface array that contains descriptions of the gateway network interfaces.

gateway_type: Option<String>

The type of the gateway.

next_update_availability_date: Option<String>

The date on which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response.

last_software_update: Option<String>

The date on which the last software update was applied to the gateway. If the gateway has never been updated, this field does not return a value in the response. This only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM

ec2_instance_id: Option<String>

The ID of the Amazon EC2 instance that was used to launch the gateway.

ec2_instance_region: Option<String>

The Amazon Web Services Region where the Amazon EC2 instance is located.

tags: Option<Vec<Tag>>

A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

vpc_endpoint: Option<String>

The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.

cloud_watch_log_group_arn: Option<String>

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway. This field only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM

host_environment: Option<HostEnvironment>

The type of hardware or software platform on which the gateway is running.

endpoint_type: Option<String>

The type of endpoint for your gateway.

Valid Values: STANDARD | FIPS

software_updates_end_date: Option<String>

Date after which this gateway will not receive software updates for new features.

deprecation_date: Option<String>

Date after which this gateway will not receive software updates for new features and bug fixes.

gateway_capacity: Option<GatewayCapacity>

Specifies the size of the gateway's metadata cache.

supported_gateway_capacities: Option<Vec<GatewayCapacity>>

A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.

host_environment_id: Option<String>

A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.

software_version: Option<String>

The version number of the software running on the gateway appliance.

Implementations

impl DescribeGatewayInformationOutput

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

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

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

The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

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

The name you configured for your gateway.

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

A value that indicates the time zone configured for the gateway.

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

A value that indicates the operating state of the gateway.

pub fn gateway_network_interfaces(&self) -> &[NetworkInterface]

A NetworkInterface array that contains descriptions of the gateway network interfaces.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .gateway_network_interfaces.is_none().

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

The type of the gateway.

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

The date on which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response.

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

The date on which the last software update was applied to the gateway. If the gateway has never been updated, this field does not return a value in the response. This only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM

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

The ID of the Amazon EC2 instance that was used to launch the gateway.

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

The Amazon Web Services Region where the Amazon EC2 instance is located.

pub fn tags(&self) -> &[Tag]

A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

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

The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.

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

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway. This field only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM

pub fn host_environment(&self) -> Option<&HostEnvironment>

The type of hardware or software platform on which the gateway is running.

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

The type of endpoint for your gateway.

Valid Values: STANDARD | FIPS

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

Date after which this gateway will not receive software updates for new features.

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

Date after which this gateway will not receive software updates for new features and bug fixes.

pub fn gateway_capacity(&self) -> Option<&GatewayCapacity>

Specifies the size of the gateway's metadata cache.

pub fn supported_gateway_capacities(&self) -> &[GatewayCapacity]

A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .supported_gateway_capacities.is_none().

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

A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.

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

The version number of the software running on the gateway appliance.

impl DescribeGatewayInformationOutput

pub fn builder() -> DescribeGatewayInformationOutputBuilder

Creates a new builder-style object to manufacture DescribeGatewayInformationOutput.

Trait Implementations

impl Clone for DescribeGatewayInformationOutput

fn clone(&self) -> DescribeGatewayInformationOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeGatewayInformationOutput

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

Formats the value using the given formatter.

impl PartialEq for DescribeGatewayInformationOutput

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for DescribeGatewayInformationOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for DescribeGatewayInformationOutput