Struct Api

#[non_exhaustive]
pub struct Api {
    pub api_id: Option<String>,
    pub name: Option<String>,
    pub owner_contact: Option<String>,
    pub tags: Option<HashMap<String, String>>,
    pub dns: Option<HashMap<String, String>>,
    pub api_arn: Option<String>,
    pub created: Option<DateTime>,
    pub xray_enabled: bool,
    pub waf_web_acl_arn: Option<String>,
    pub event_config: Option<EventConfig>,
}

Describes an AppSync API. You can use Api for an AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.

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.

api_id: Option<String>

The Api ID.

name: Option<String>

The name of the Api.

owner_contact: Option<String>

The owner contact information for the Api

tags: Option<HashMap<String, String>>

A map with keys of TagKey objects and values of TagValue objects.

dns: Option<HashMap<String, String>>

The DNS records for the API. This will include an HTTP and a real-time endpoint.

api_arn: Option<String>

The Amazon Resource Name (ARN) for the Api.

created: Option<DateTime>

The date and time that the Api was created.

xray_enabled: bool

A flag indicating whether to use X-Ray tracing for this Api.

waf_web_acl_arn: Option<String>

The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this Api, if one exists.

event_config: Option<EventConfig>

The Event API configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.

Implementations

impl Api

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

The Api ID.

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

The name of the Api.

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

The owner contact information for the Api

pub fn tags(&self) -> Option<&HashMap<String, String>>

A map with keys of TagKey objects and values of TagValue objects.

pub fn dns(&self) -> Option<&HashMap<String, String>>

The DNS records for the API. This will include an HTTP and a real-time endpoint.

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

The Amazon Resource Name (ARN) for the Api.

pub fn created(&self) -> Option<&DateTime>

The date and time that the Api was created.

pub fn xray_enabled(&self) -> bool

A flag indicating whether to use X-Ray tracing for this Api.

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

The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this Api, if one exists.

pub fn event_config(&self) -> Option<&EventConfig>

The Event API configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.

impl Api

pub fn builder() -> ApiBuilder

Creates a new builder-style object to manufacture Api.

Trait Implementations

impl Clone for Api

fn clone(&self) -> Api

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Api

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

Formats the value using the given formatter.

impl PartialEq for Api

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Api