Struct aws_sdk_qbusiness::operation::create_index::CreateIndexInput

#[non_exhaustive]
pub struct CreateIndexInput {
    pub application_id: Option<String>,
    pub display_name: Option<String>,
    pub description: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub capacity_configuration: Option<IndexCapacityConfiguration>,
    pub client_token: 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.

application_id: Option<String>

The identifier of the Amazon Q application using the index.

display_name: Option<String>

A name for the Amazon Q index.

description: Option<String>

A description for the Amazon Q index.

tags: Option<Vec<Tag>>

A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

capacity_configuration: Option<IndexCapacityConfiguration>

The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.

client_token: Option<String>

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

Implementations

impl CreateIndexInput

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

The identifier of the Amazon Q application using the index.

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

A name for the Amazon Q index.

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

A description for the Amazon Q index.

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

A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

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 capacity_configuration(&self) -> Option<&IndexCapacityConfiguration>

The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.

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

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

impl CreateIndexInput

pub fn builder() -> CreateIndexInputBuilder

Creates a new builder-style object to manufacture CreateIndexInput.

Trait Implementations

impl Clone for CreateIndexInput

fn clone(&self) -> CreateIndexInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateIndexInput

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

Formats the value using the given formatter.

impl PartialEq for CreateIndexInput

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