Struct aws_sdk_verifiedpermissions::operation::create_identity_source::builders::CreateIdentitySourceFluentBuilder

pub struct CreateIdentitySourceFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateIdentitySource.

Creates a reference to an Amazon Cognito user pool as an external identity provider (IdP).

After you create an identity source, you can use the identities provided by the IdP as proxies for the principal in authorization queries that use the IsAuthorizedWithToken operation. These identities take the form of tokens that contain claims about the user, such as IDs, attributes and group memberships. Amazon Cognito provides both identity tokens and access tokens, and Verified Permissions can use either or both. Any combination of identity and access tokens results in the same Cedar principal. Verified Permissions automatically translates the information about the identities into the standard Cedar attributes that can be evaluated by your policies. Because the Amazon Cognito identity and access tokens can contain different information, the tokens you choose to use determine which principal attributes are available to access when evaluating Cedar policies.

If you delete a Amazon Cognito user pool or user, tokens from that deleted pool or that deleted user continue to be usable until they expire.

To reference a user from this identity source in your Cedar policies, use the following syntax.

IdentityType::"<CognitoUserPoolIdentifier>|<CognitoClientId>

Where IdentityType is the string that you provide to the PrincipalEntityType parameter for this operation. The CognitoUserPoolId and CognitoClientId are defined by the Amazon Cognito user pool.

Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to be propagate through the service and be visible in the results of other Verified Permissions operations.

Implementations

impl CreateIdentitySourceFluentBuilder

pub fn as_input(&self) -> &CreateIdentitySourceInputBuilder

Access the CreateIdentitySource as a reference.

pub async fn send( self ) -> Result<CreateIdentitySourceOutput, SdkError<CreateIdentitySourceError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub async fn customize( self ) -> Result<CustomizableOperation<CreateIdentitySourceOutput, CreateIdentitySourceError, Self>, SdkError<CreateIdentitySourceError>>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn client_token(self, input: impl Into<String>) -> Self

Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

pub fn set_client_token(self, input: Option<String>) -> Self

Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

pub fn get_client_token(&self) -> &Option<String>

Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

pub fn policy_store_id(self, input: impl Into<String>) -> Self

Specifies the ID of the policy store in which you want to store this identity source. Only policies and requests made using this policy store can reference identities from the identity provider configured in the new identity source.

pub fn set_policy_store_id(self, input: Option<String>) -> Self

Specifies the ID of the policy store in which you want to store this identity source. Only policies and requests made using this policy store can reference identities from the identity provider configured in the new identity source.

pub fn get_policy_store_id(&self) -> &Option<String>

Specifies the ID of the policy store in which you want to store this identity source. Only policies and requests made using this policy store can reference identities from the identity provider configured in the new identity source.

pub fn configuration(self, input: Configuration) -> Self

Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.

At this time, the only valid member of this structure is a Amazon Cognito user pool configuration.

You must specify a UserPoolArn, and optionally, a ClientId.

pub fn set_configuration(self, input: Option<Configuration>) -> Self

Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.

At this time, the only valid member of this structure is a Amazon Cognito user pool configuration.

You must specify a UserPoolArn, and optionally, a ClientId.

pub fn get_configuration(&self) -> &Option<Configuration>

Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.

At this time, the only valid member of this structure is a Amazon Cognito user pool configuration.

You must specify a UserPoolArn, and optionally, a ClientId.

pub fn principal_entity_type(self, input: impl Into<String>) -> Self

Specifies the namespace and data type of the principals generated for identities authenticated by the new identity source.

pub fn set_principal_entity_type(self, input: Option<String>) -> Self

Specifies the namespace and data type of the principals generated for identities authenticated by the new identity source.

pub fn get_principal_entity_type(&self) -> &Option<String>

Specifies the namespace and data type of the principals generated for identities authenticated by the new identity source.

Trait Implementations

impl Clone for CreateIdentitySourceFluentBuilder

fn clone(&self) -> CreateIdentitySourceFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateIdentitySourceFluentBuilder

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

Formats the value using the given formatter.