aws-sdk-opensearchserverless 1.100.0

AWS SDK for OpenSearch Service Serverless
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct CreateSecurityConfigInput {
    /// <p>The type of security configuration.</p>
    pub r#type: ::std::option::Option<crate::types::SecurityConfigType>,
    /// <p>The name of the security configuration.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>A description of the security configuration.</p>
    pub description: ::std::option::Option<::std::string::String>,
    /// <p>Describes SAML options in the form of a key-value map. This field is required if you specify <code>SAML</code> for the <code>type</code> parameter.</p>
    pub saml_options: ::std::option::Option<crate::types::SamlConfigOptions>,
    /// <p>Describes IAM Identity Center options in the form of a key-value map. This field is required if you specify <code>iamidentitycenter</code> for the <code>type</code> parameter.</p>
    pub iam_identity_center_options: ::std::option::Option<crate::types::CreateIamIdentityCenterConfigOptions>,
    /// <p>Describes IAM federation options in the form of a key-value map. This field is required if you specify <code>iamFederation</code> for the <code>type</code> parameter.</p>
    pub iam_federation_options: ::std::option::Option<crate::types::IamFederationConfigOptions>,
    /// <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
    pub client_token: ::std::option::Option<::std::string::String>,
}
impl CreateSecurityConfigInput {
    /// <p>The type of security configuration.</p>
    pub fn r#type(&self) -> ::std::option::Option<&crate::types::SecurityConfigType> {
        self.r#type.as_ref()
    }
    /// <p>The name of the security configuration.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>A description of the security configuration.</p>
    pub fn description(&self) -> ::std::option::Option<&str> {
        self.description.as_deref()
    }
    /// <p>Describes SAML options in the form of a key-value map. This field is required if you specify <code>SAML</code> for the <code>type</code> parameter.</p>
    pub fn saml_options(&self) -> ::std::option::Option<&crate::types::SamlConfigOptions> {
        self.saml_options.as_ref()
    }
    /// <p>Describes IAM Identity Center options in the form of a key-value map. This field is required if you specify <code>iamidentitycenter</code> for the <code>type</code> parameter.</p>
    pub fn iam_identity_center_options(&self) -> ::std::option::Option<&crate::types::CreateIamIdentityCenterConfigOptions> {
        self.iam_identity_center_options.as_ref()
    }
    /// <p>Describes IAM federation options in the form of a key-value map. This field is required if you specify <code>iamFederation</code> for the <code>type</code> parameter.</p>
    pub fn iam_federation_options(&self) -> ::std::option::Option<&crate::types::IamFederationConfigOptions> {
        self.iam_federation_options.as_ref()
    }
    /// <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
    pub fn client_token(&self) -> ::std::option::Option<&str> {
        self.client_token.as_deref()
    }
}
impl CreateSecurityConfigInput {
    /// Creates a new builder-style object to manufacture [`CreateSecurityConfigInput`](crate::operation::create_security_config::CreateSecurityConfigInput).
    pub fn builder() -> crate::operation::create_security_config::builders::CreateSecurityConfigInputBuilder {
        crate::operation::create_security_config::builders::CreateSecurityConfigInputBuilder::default()
    }
}

/// A builder for [`CreateSecurityConfigInput`](crate::operation::create_security_config::CreateSecurityConfigInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CreateSecurityConfigInputBuilder {
    pub(crate) r#type: ::std::option::Option<crate::types::SecurityConfigType>,
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) description: ::std::option::Option<::std::string::String>,
    pub(crate) saml_options: ::std::option::Option<crate::types::SamlConfigOptions>,
    pub(crate) iam_identity_center_options: ::std::option::Option<crate::types::CreateIamIdentityCenterConfigOptions>,
    pub(crate) iam_federation_options: ::std::option::Option<crate::types::IamFederationConfigOptions>,
    pub(crate) client_token: ::std::option::Option<::std::string::String>,
}
impl CreateSecurityConfigInputBuilder {
    /// <p>The type of security configuration.</p>
    /// This field is required.
    pub fn r#type(mut self, input: crate::types::SecurityConfigType) -> Self {
        self.r#type = ::std::option::Option::Some(input);
        self
    }
    /// <p>The type of security configuration.</p>
    pub fn set_type(mut self, input: ::std::option::Option<crate::types::SecurityConfigType>) -> Self {
        self.r#type = input;
        self
    }
    /// <p>The type of security configuration.</p>
    pub fn get_type(&self) -> &::std::option::Option<crate::types::SecurityConfigType> {
        &self.r#type
    }
    /// <p>The name of the security configuration.</p>
    /// This field is required.
    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the security configuration.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>The name of the security configuration.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>A description of the security configuration.</p>
    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.description = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A description of the security configuration.</p>
    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.description = input;
        self
    }
    /// <p>A description of the security configuration.</p>
    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.description
    }
    /// <p>Describes SAML options in the form of a key-value map. This field is required if you specify <code>SAML</code> for the <code>type</code> parameter.</p>
    pub fn saml_options(mut self, input: crate::types::SamlConfigOptions) -> Self {
        self.saml_options = ::std::option::Option::Some(input);
        self
    }
    /// <p>Describes SAML options in the form of a key-value map. This field is required if you specify <code>SAML</code> for the <code>type</code> parameter.</p>
    pub fn set_saml_options(mut self, input: ::std::option::Option<crate::types::SamlConfigOptions>) -> Self {
        self.saml_options = input;
        self
    }
    /// <p>Describes SAML options in the form of a key-value map. This field is required if you specify <code>SAML</code> for the <code>type</code> parameter.</p>
    pub fn get_saml_options(&self) -> &::std::option::Option<crate::types::SamlConfigOptions> {
        &self.saml_options
    }
    /// <p>Describes IAM Identity Center options in the form of a key-value map. This field is required if you specify <code>iamidentitycenter</code> for the <code>type</code> parameter.</p>
    pub fn iam_identity_center_options(mut self, input: crate::types::CreateIamIdentityCenterConfigOptions) -> Self {
        self.iam_identity_center_options = ::std::option::Option::Some(input);
        self
    }
    /// <p>Describes IAM Identity Center options in the form of a key-value map. This field is required if you specify <code>iamidentitycenter</code> for the <code>type</code> parameter.</p>
    pub fn set_iam_identity_center_options(mut self, input: ::std::option::Option<crate::types::CreateIamIdentityCenterConfigOptions>) -> Self {
        self.iam_identity_center_options = input;
        self
    }
    /// <p>Describes IAM Identity Center options in the form of a key-value map. This field is required if you specify <code>iamidentitycenter</code> for the <code>type</code> parameter.</p>
    pub fn get_iam_identity_center_options(&self) -> &::std::option::Option<crate::types::CreateIamIdentityCenterConfigOptions> {
        &self.iam_identity_center_options
    }
    /// <p>Describes IAM federation options in the form of a key-value map. This field is required if you specify <code>iamFederation</code> for the <code>type</code> parameter.</p>
    pub fn iam_federation_options(mut self, input: crate::types::IamFederationConfigOptions) -> Self {
        self.iam_federation_options = ::std::option::Option::Some(input);
        self
    }
    /// <p>Describes IAM federation options in the form of a key-value map. This field is required if you specify <code>iamFederation</code> for the <code>type</code> parameter.</p>
    pub fn set_iam_federation_options(mut self, input: ::std::option::Option<crate::types::IamFederationConfigOptions>) -> Self {
        self.iam_federation_options = input;
        self
    }
    /// <p>Describes IAM federation options in the form of a key-value map. This field is required if you specify <code>iamFederation</code> for the <code>type</code> parameter.</p>
    pub fn get_iam_federation_options(&self) -> &::std::option::Option<crate::types::IamFederationConfigOptions> {
        &self.iam_federation_options
    }
    /// <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.client_token = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.client_token = input;
        self
    }
    /// <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>
    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.client_token
    }
    /// Consumes the builder and constructs a [`CreateSecurityConfigInput`](crate::operation::create_security_config::CreateSecurityConfigInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::create_security_config::CreateSecurityConfigInput, ::aws_smithy_types::error::operation::BuildError>
    {
        ::std::result::Result::Ok(crate::operation::create_security_config::CreateSecurityConfigInput {
            r#type: self.r#type,
            name: self.name,
            description: self.description,
            saml_options: self.saml_options,
            iam_identity_center_options: self.iam_identity_center_options,
            iam_federation_options: self.iam_federation_options,
            client_token: self.client_token,
        })
    }
}