aws_sdk_cognitoidentityprovider/client/
create_resource_server.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`CreateResourceServer`](crate::operation::create_resource_server::builders::CreateResourceServerFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`user_pool_id(impl Into<String>)`](crate::operation::create_resource_server::builders::CreateResourceServerFluentBuilder::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::operation::create_resource_server::builders::CreateResourceServerFluentBuilder::set_user_pool_id):<br>required: **true**<br><p>The ID of the user pool where you want to create a resource server.</p><br>
7    ///   - [`identifier(impl Into<String>)`](crate::operation::create_resource_server::builders::CreateResourceServerFluentBuilder::identifier) / [`set_identifier(Option<String>)`](crate::operation::create_resource_server::builders::CreateResourceServerFluentBuilder::set_identifier):<br>required: **true**<br><p>A unique resource server identifier for the resource server. The identifier can be an API friendly name like <code>solar-system-data</code>. You can also set an API URL like <code>https://solar-system-data-api.example.com</code> as your identifier.</p> <p>Amazon Cognito represents scopes in the access token in the format <code>$resource-server-identifier/$scope</code>. Longer scope-identifier strings increase the size of your access tokens.</p><br>
8    ///   - [`name(impl Into<String>)`](crate::operation::create_resource_server::builders::CreateResourceServerFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_resource_server::builders::CreateResourceServerFluentBuilder::set_name):<br>required: **true**<br><p>A friendly name for the resource server.</p><br>
9    ///   - [`scopes(ResourceServerScopeType)`](crate::operation::create_resource_server::builders::CreateResourceServerFluentBuilder::scopes) / [`set_scopes(Option<Vec::<ResourceServerScopeType>>)`](crate::operation::create_resource_server::builders::CreateResourceServerFluentBuilder::set_scopes):<br>required: **false**<br><p>A list of custom scopes. Each scope is a key-value map with the keys <code>ScopeName</code> and <code>ScopeDescription</code>. The name of a custom scope is a combination of <code>ScopeName</code> and the resource server <code>Name</code> in this request, for example <code>MyResourceServerName/MyScopeName</code>.</p><br>
10    /// - On success, responds with [`CreateResourceServerOutput`](crate::operation::create_resource_server::CreateResourceServerOutput) with field(s):
11    ///   - [`resource_server(Option<ResourceServerType>)`](crate::operation::create_resource_server::CreateResourceServerOutput::resource_server): <p>The details of the new resource server.</p>
12    /// - On failure, responds with [`SdkError<CreateResourceServerError>`](crate::operation::create_resource_server::CreateResourceServerError)
13    pub fn create_resource_server(&self) -> crate::operation::create_resource_server::builders::CreateResourceServerFluentBuilder {
14        crate::operation::create_resource_server::builders::CreateResourceServerFluentBuilder::new(self.handle.clone())
15    }
16}