class Aws::OpenSearchService::Types::CognitoOptions
Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see [Configuring Amazon Cognito authentication for OpenSearch Dashboards].
[1]: docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html
@note When making an API call, you may pass CognitoOptions
data as a hash: { enabled: false, user_pool_id: "UserPoolId", identity_pool_id: "IdentityPoolId", role_arn: "RoleArn", }
@!attribute [rw] enabled
The option to enable Cognito for OpenSearch Dashboards authentication. @return [Boolean]
@!attribute [rw] user_pool_id
The Cognito user pool ID for OpenSearch Dashboards authentication. @return [String]
@!attribute [rw] identity_pool_id
The Cognito identity pool ID for OpenSearch Dashboards authentication. @return [String]
@!attribute [rw] role_arn
The role ARN that provides OpenSearch permissions for accessing Cognito resources. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CognitoOptions AWS API Documentation
Constants
- SENSITIVE