Struct aws_sdk_networkfirewall::operation::update_firewall_description::UpdateFirewallDescriptionInput

#[non_exhaustive]
pub struct UpdateFirewallDescriptionInput {
    pub update_token: Option<String>,
    pub firewall_arn: Option<String>,
    pub firewall_name: Option<String>,
    pub description: Option<String>,
}

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.

update_token: Option<String>

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

firewall_arn: Option<String>

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

firewall_name: Option<String>

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

description: Option<String>

The new description for the firewall. If you omit this setting, Network Firewall removes the description for the firewall.

Implementations

impl UpdateFirewallDescriptionInput

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

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

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

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

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

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

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

The new description for the firewall. If you omit this setting, Network Firewall removes the description for the firewall.

impl UpdateFirewallDescriptionInput

pub fn builder() -> UpdateFirewallDescriptionInputBuilder

Creates a new builder-style object to manufacture UpdateFirewallDescriptionInput.

Trait Implementations

impl Clone for UpdateFirewallDescriptionInput

fn clone(&self) -> UpdateFirewallDescriptionInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateFirewallDescriptionInput

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

Formats the value using the given formatter.

impl PartialEq for UpdateFirewallDescriptionInput

fn eq(&self, other: &UpdateFirewallDescriptionInput) -> 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 StructuralPartialEq for UpdateFirewallDescriptionInput