AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
aws.cognito.getUserPoolClient
Explore with Pulumi AI
Provides a Cognito User Pool Client resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const client = aws.cognito.getUserPoolClient({
clientId: "38fjsnc484p94kpqsnet7mpld0",
userPoolId: "us-west-2_aaaaaaaaa",
});
import pulumi
import pulumi_aws as aws
client = aws.cognito.get_user_pool_client(client_id="38fjsnc484p94kpqsnet7mpld0",
user_pool_id="us-west-2_aaaaaaaaa")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cognito"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cognito.LookupUserPoolClient(ctx, &cognito.LookupUserPoolClientArgs{
ClientId: "38fjsnc484p94kpqsnet7mpld0",
UserPoolId: "us-west-2_aaaaaaaaa",
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var client = Aws.Cognito.GetUserPoolClient.Invoke(new()
{
ClientId = "38fjsnc484p94kpqsnet7mpld0",
UserPoolId = "us-west-2_aaaaaaaaa",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cognito.CognitoFunctions;
import com.pulumi.aws.cognito.inputs.GetUserPoolClientArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var client = CognitoFunctions.getUserPoolClient(GetUserPoolClientArgs.builder()
.clientId("38fjsnc484p94kpqsnet7mpld0")
.userPoolId("us-west-2_aaaaaaaaa")
.build());
}
}
variables:
client:
fn::invoke:
Function: aws:cognito:getUserPoolClient
Arguments:
clientId: 38fjsnc484p94kpqsnet7mpld0
userPoolId: us-west-2_aaaaaaaaa
Using getUserPoolClient
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getUserPoolClient(args: GetUserPoolClientArgs, opts?: InvokeOptions): Promise<GetUserPoolClientResult>
function getUserPoolClientOutput(args: GetUserPoolClientOutputArgs, opts?: InvokeOptions): Output<GetUserPoolClientResult>
def get_user_pool_client(client_id: Optional[str] = None,
user_pool_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetUserPoolClientResult
def get_user_pool_client_output(client_id: Optional[pulumi.Input[str]] = None,
user_pool_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetUserPoolClientResult]
func LookupUserPoolClient(ctx *Context, args *LookupUserPoolClientArgs, opts ...InvokeOption) (*LookupUserPoolClientResult, error)
func LookupUserPoolClientOutput(ctx *Context, args *LookupUserPoolClientOutputArgs, opts ...InvokeOption) LookupUserPoolClientResultOutput
> Note: This function is named LookupUserPoolClient
in the Go SDK.
public static class GetUserPoolClient
{
public static Task<GetUserPoolClientResult> InvokeAsync(GetUserPoolClientArgs args, InvokeOptions? opts = null)
public static Output<GetUserPoolClientResult> Invoke(GetUserPoolClientInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetUserPoolClientResult> getUserPoolClient(GetUserPoolClientArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws:cognito/getUserPoolClient:getUserPoolClient
arguments:
# arguments dictionary
The following arguments are supported:
- Client
Id string - Client Id of the user pool.
- User
Pool stringId - User pool the client belongs to.
- Client
Id string - Client Id of the user pool.
- User
Pool stringId - User pool the client belongs to.
- client
Id String - Client Id of the user pool.
- user
Pool StringId - User pool the client belongs to.
- client
Id string - Client Id of the user pool.
- user
Pool stringId - User pool the client belongs to.
- client_
id str - Client Id of the user pool.
- user_
pool_ strid - User pool the client belongs to.
- client
Id String - Client Id of the user pool.
- user
Pool StringId - User pool the client belongs to.
getUserPoolClient Result
The following output properties are available:
- Access
Token intValidity - (Optional) Time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. This value will be overridden if you have entered a value in
token_validity_units
. - Allowed
Oauth List<string>Flows - (Optional) List of allowed OAuth flows (code, implicit, client_credentials).
- Allowed
Oauth boolFlows User Pool Client - (Optional) Whether the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
- Allowed
Oauth List<string>Scopes - (Optional) List of allowed OAuth scopes (phone, email, openid, profile, and aws.cognito.signin.user.admin).
- Analytics
Configurations List<GetUser Pool Client Analytics Configuration> - (Optional) Configuration block for Amazon Pinpoint analytics for collecting metrics for this user pool. Detailed below.
- Callback
Urls List<string> - (Optional) List of allowed callback URLs for the identity providers.
- Client
Id string - Client
Secret string - Client secret of the user pool client.
- Default
Redirect stringUri - (Optional) Default redirect URI. Must be in the list of callback URLs.
- Enable
Propagate boolAdditional User Context Data - Enable
Token boolRevocation - (Optional) Enables or disables token revocation.
- Explicit
Auth List<string>Flows - (Optional) List of authentication flows (ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH, ALLOW_ADMIN_USER_PASSWORD_AUTH, ALLOW_CUSTOM_AUTH, ALLOW_USER_PASSWORD_AUTH, ALLOW_USER_SRP_AUTH, ALLOW_REFRESH_TOKEN_AUTH).
- Generate
Secret bool - (Optional) Should an application secret be generated.
- Id string
- The provider-assigned unique ID for this managed resource.
- Id
Token intValidity - (Optional) Time limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be used. This value will be overridden if you have entered a value in
token_validity_units
. - Logout
Urls List<string> - (Optional) List of allowed logout URLs for the identity providers.
- Name string
- Prevent
User stringExistence Errors - (Optional) Choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to
ENABLED
and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set toLEGACY
, those APIs will return aUserNotFoundException
exception if the user does not exist in the user pool. - Read
Attributes List<string> - (Optional) List of user pool attributes the application client can read from.
- Refresh
Token intValidity - (Optional) Time limit in days refresh tokens are valid for.
- Supported
Identity List<string>Providers - (Optional) List of provider names for the identity providers that are supported on this client. Uses the
provider_name
attribute ofaws.cognito.IdentityProvider
resource(s), or the equivalent string(s). - Token
Validity List<GetUnits User Pool Client Token Validity Unit> - (Optional) Configuration block for units in which the validity times are represented in. Detailed below.
- User
Pool stringId - Write
Attributes List<string> - (Optional) List of user pool attributes the application client can write to.
- Access
Token intValidity - (Optional) Time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. This value will be overridden if you have entered a value in
token_validity_units
. - Allowed
Oauth []stringFlows - (Optional) List of allowed OAuth flows (code, implicit, client_credentials).
- Allowed
Oauth boolFlows User Pool Client - (Optional) Whether the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
- Allowed
Oauth []stringScopes - (Optional) List of allowed OAuth scopes (phone, email, openid, profile, and aws.cognito.signin.user.admin).
- Analytics
Configurations []GetUser Pool Client Analytics Configuration - (Optional) Configuration block for Amazon Pinpoint analytics for collecting metrics for this user pool. Detailed below.
- Callback
Urls []string - (Optional) List of allowed callback URLs for the identity providers.
- Client
Id string - Client
Secret string - Client secret of the user pool client.
- Default
Redirect stringUri - (Optional) Default redirect URI. Must be in the list of callback URLs.
- Enable
Propagate boolAdditional User Context Data - Enable
Token boolRevocation - (Optional) Enables or disables token revocation.
- Explicit
Auth []stringFlows - (Optional) List of authentication flows (ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH, ALLOW_ADMIN_USER_PASSWORD_AUTH, ALLOW_CUSTOM_AUTH, ALLOW_USER_PASSWORD_AUTH, ALLOW_USER_SRP_AUTH, ALLOW_REFRESH_TOKEN_AUTH).
- Generate
Secret bool - (Optional) Should an application secret be generated.
- Id string
- The provider-assigned unique ID for this managed resource.
- Id
Token intValidity - (Optional) Time limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be used. This value will be overridden if you have entered a value in
token_validity_units
. - Logout
Urls []string - (Optional) List of allowed logout URLs for the identity providers.
- Name string
- Prevent
User stringExistence Errors - (Optional) Choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to
ENABLED
and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set toLEGACY
, those APIs will return aUserNotFoundException
exception if the user does not exist in the user pool. - Read
Attributes []string - (Optional) List of user pool attributes the application client can read from.
- Refresh
Token intValidity - (Optional) Time limit in days refresh tokens are valid for.
- Supported
Identity []stringProviders - (Optional) List of provider names for the identity providers that are supported on this client. Uses the
provider_name
attribute ofaws.cognito.IdentityProvider
resource(s), or the equivalent string(s). - Token
Validity []GetUnits User Pool Client Token Validity Unit - (Optional) Configuration block for units in which the validity times are represented in. Detailed below.
- User
Pool stringId - Write
Attributes []string - (Optional) List of user pool attributes the application client can write to.
- access
Token IntegerValidity - (Optional) Time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. This value will be overridden if you have entered a value in
token_validity_units
. - allowed
Oauth List<String>Flows - (Optional) List of allowed OAuth flows (code, implicit, client_credentials).
- allowed
Oauth BooleanFlows User Pool Client - (Optional) Whether the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
- allowed
Oauth List<String>Scopes - (Optional) List of allowed OAuth scopes (phone, email, openid, profile, and aws.cognito.signin.user.admin).
- analytics
Configurations List<GetUser Pool Client Analytics Configuration> - (Optional) Configuration block for Amazon Pinpoint analytics for collecting metrics for this user pool. Detailed below.
- callback
Urls List<String> - (Optional) List of allowed callback URLs for the identity providers.
- client
Id String - client
Secret String - Client secret of the user pool client.
- default
Redirect StringUri - (Optional) Default redirect URI. Must be in the list of callback URLs.
- enable
Propagate BooleanAdditional User Context Data - enable
Token BooleanRevocation - (Optional) Enables or disables token revocation.
- explicit
Auth List<String>Flows - (Optional) List of authentication flows (ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH, ALLOW_ADMIN_USER_PASSWORD_AUTH, ALLOW_CUSTOM_AUTH, ALLOW_USER_PASSWORD_AUTH, ALLOW_USER_SRP_AUTH, ALLOW_REFRESH_TOKEN_AUTH).
- generate
Secret Boolean - (Optional) Should an application secret be generated.
- id String
- The provider-assigned unique ID for this managed resource.
- id
Token IntegerValidity - (Optional) Time limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be used. This value will be overridden if you have entered a value in
token_validity_units
. - logout
Urls List<String> - (Optional) List of allowed logout URLs for the identity providers.
- name String
- prevent
User StringExistence Errors - (Optional) Choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to
ENABLED
and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set toLEGACY
, those APIs will return aUserNotFoundException
exception if the user does not exist in the user pool. - read
Attributes List<String> - (Optional) List of user pool attributes the application client can read from.
- refresh
Token IntegerValidity - (Optional) Time limit in days refresh tokens are valid for.
- supported
Identity List<String>Providers - (Optional) List of provider names for the identity providers that are supported on this client. Uses the
provider_name
attribute ofaws.cognito.IdentityProvider
resource(s), or the equivalent string(s). - token
Validity List<GetUnits User Pool Client Token Validity Unit> - (Optional) Configuration block for units in which the validity times are represented in. Detailed below.
- user
Pool StringId - write
Attributes List<String> - (Optional) List of user pool attributes the application client can write to.
- access
Token numberValidity - (Optional) Time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. This value will be overridden if you have entered a value in
token_validity_units
. - allowed
Oauth string[]Flows - (Optional) List of allowed OAuth flows (code, implicit, client_credentials).
- allowed
Oauth booleanFlows User Pool Client - (Optional) Whether the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
- allowed
Oauth string[]Scopes - (Optional) List of allowed OAuth scopes (phone, email, openid, profile, and aws.cognito.signin.user.admin).
- analytics
Configurations GetUser Pool Client Analytics Configuration[] - (Optional) Configuration block for Amazon Pinpoint analytics for collecting metrics for this user pool. Detailed below.
- callback
Urls string[] - (Optional) List of allowed callback URLs for the identity providers.
- client
Id string - client
Secret string - Client secret of the user pool client.
- default
Redirect stringUri - (Optional) Default redirect URI. Must be in the list of callback URLs.
- enable
Propagate booleanAdditional User Context Data - enable
Token booleanRevocation - (Optional) Enables or disables token revocation.
- explicit
Auth string[]Flows - (Optional) List of authentication flows (ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH, ALLOW_ADMIN_USER_PASSWORD_AUTH, ALLOW_CUSTOM_AUTH, ALLOW_USER_PASSWORD_AUTH, ALLOW_USER_SRP_AUTH, ALLOW_REFRESH_TOKEN_AUTH).
- generate
Secret boolean - (Optional) Should an application secret be generated.
- id string
- The provider-assigned unique ID for this managed resource.
- id
Token numberValidity - (Optional) Time limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be used. This value will be overridden if you have entered a value in
token_validity_units
. - logout
Urls string[] - (Optional) List of allowed logout URLs for the identity providers.
- name string
- prevent
User stringExistence Errors - (Optional) Choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to
ENABLED
and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set toLEGACY
, those APIs will return aUserNotFoundException
exception if the user does not exist in the user pool. - read
Attributes string[] - (Optional) List of user pool attributes the application client can read from.
- refresh
Token numberValidity - (Optional) Time limit in days refresh tokens are valid for.
- supported
Identity string[]Providers - (Optional) List of provider names for the identity providers that are supported on this client. Uses the
provider_name
attribute ofaws.cognito.IdentityProvider
resource(s), or the equivalent string(s). - token
Validity GetUnits User Pool Client Token Validity Unit[] - (Optional) Configuration block for units in which the validity times are represented in. Detailed below.
- user
Pool stringId - write
Attributes string[] - (Optional) List of user pool attributes the application client can write to.
- access_
token_ intvalidity - (Optional) Time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. This value will be overridden if you have entered a value in
token_validity_units
. - allowed_
oauth_ Sequence[str]flows - (Optional) List of allowed OAuth flows (code, implicit, client_credentials).
- allowed_
oauth_ boolflows_ user_ pool_ client - (Optional) Whether the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
- allowed_
oauth_ Sequence[str]scopes - (Optional) List of allowed OAuth scopes (phone, email, openid, profile, and aws.cognito.signin.user.admin).
- analytics_
configurations Sequence[GetUser Pool Client Analytics Configuration] - (Optional) Configuration block for Amazon Pinpoint analytics for collecting metrics for this user pool. Detailed below.
- callback_
urls Sequence[str] - (Optional) List of allowed callback URLs for the identity providers.
- client_
id str - client_
secret str - Client secret of the user pool client.
- default_
redirect_ struri - (Optional) Default redirect URI. Must be in the list of callback URLs.
- enable_
propagate_ booladditional_ user_ context_ data - enable_
token_ boolrevocation - (Optional) Enables or disables token revocation.
- explicit_
auth_ Sequence[str]flows - (Optional) List of authentication flows (ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH, ALLOW_ADMIN_USER_PASSWORD_AUTH, ALLOW_CUSTOM_AUTH, ALLOW_USER_PASSWORD_AUTH, ALLOW_USER_SRP_AUTH, ALLOW_REFRESH_TOKEN_AUTH).
- generate_
secret bool - (Optional) Should an application secret be generated.
- id str
- The provider-assigned unique ID for this managed resource.
- id_
token_ intvalidity - (Optional) Time limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be used. This value will be overridden if you have entered a value in
token_validity_units
. - logout_
urls Sequence[str] - (Optional) List of allowed logout URLs for the identity providers.
- name str
- prevent_
user_ strexistence_ errors - (Optional) Choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to
ENABLED
and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set toLEGACY
, those APIs will return aUserNotFoundException
exception if the user does not exist in the user pool. - read_
attributes Sequence[str] - (Optional) List of user pool attributes the application client can read from.
- refresh_
token_ intvalidity - (Optional) Time limit in days refresh tokens are valid for.
- supported_
identity_ Sequence[str]providers - (Optional) List of provider names for the identity providers that are supported on this client. Uses the
provider_name
attribute ofaws.cognito.IdentityProvider
resource(s), or the equivalent string(s). - token_
validity_ Sequence[Getunits User Pool Client Token Validity Unit] - (Optional) Configuration block for units in which the validity times are represented in. Detailed below.
- user_
pool_ strid - write_
attributes Sequence[str] - (Optional) List of user pool attributes the application client can write to.
- access
Token NumberValidity - (Optional) Time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. This value will be overridden if you have entered a value in
token_validity_units
. - allowed
Oauth List<String>Flows - (Optional) List of allowed OAuth flows (code, implicit, client_credentials).
- allowed
Oauth BooleanFlows User Pool Client - (Optional) Whether the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
- allowed
Oauth List<String>Scopes - (Optional) List of allowed OAuth scopes (phone, email, openid, profile, and aws.cognito.signin.user.admin).
- analytics
Configurations List<Property Map> - (Optional) Configuration block for Amazon Pinpoint analytics for collecting metrics for this user pool. Detailed below.
- callback
Urls List<String> - (Optional) List of allowed callback URLs for the identity providers.
- client
Id String - client
Secret String - Client secret of the user pool client.
- default
Redirect StringUri - (Optional) Default redirect URI. Must be in the list of callback URLs.
- enable
Propagate BooleanAdditional User Context Data - enable
Token BooleanRevocation - (Optional) Enables or disables token revocation.
- explicit
Auth List<String>Flows - (Optional) List of authentication flows (ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH, ALLOW_ADMIN_USER_PASSWORD_AUTH, ALLOW_CUSTOM_AUTH, ALLOW_USER_PASSWORD_AUTH, ALLOW_USER_SRP_AUTH, ALLOW_REFRESH_TOKEN_AUTH).
- generate
Secret Boolean - (Optional) Should an application secret be generated.
- id String
- The provider-assigned unique ID for this managed resource.
- id
Token NumberValidity - (Optional) Time limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be used. This value will be overridden if you have entered a value in
token_validity_units
. - logout
Urls List<String> - (Optional) List of allowed logout URLs for the identity providers.
- name String
- prevent
User StringExistence Errors - (Optional) Choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to
ENABLED
and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set toLEGACY
, those APIs will return aUserNotFoundException
exception if the user does not exist in the user pool. - read
Attributes List<String> - (Optional) List of user pool attributes the application client can read from.
- refresh
Token NumberValidity - (Optional) Time limit in days refresh tokens are valid for.
- supported
Identity List<String>Providers - (Optional) List of provider names for the identity providers that are supported on this client. Uses the
provider_name
attribute ofaws.cognito.IdentityProvider
resource(s), or the equivalent string(s). - token
Validity List<Property Map>Units - (Optional) Configuration block for units in which the validity times are represented in. Detailed below.
- user
Pool StringId - write
Attributes List<String> - (Optional) List of user pool attributes the application client can write to.
Supporting Types
GetUserPoolClientAnalyticsConfiguration
- Application
Arn string - (Optional) Application ARN for an Amazon Pinpoint application. Conflicts with
external_id
androle_arn
. - Application
Id string - (Optional) Application ID for an Amazon Pinpoint application.
- External
Id string - (Optional) ID for the Analytics Configuration. Conflicts with
application_arn
. - Role
Arn string - (Optional) ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics. Conflicts with
application_arn
. - bool
- (Optional) If set to
true
, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.
- Application
Arn string - (Optional) Application ARN for an Amazon Pinpoint application. Conflicts with
external_id
androle_arn
. - Application
Id string - (Optional) Application ID for an Amazon Pinpoint application.
- External
Id string - (Optional) ID for the Analytics Configuration. Conflicts with
application_arn
. - Role
Arn string - (Optional) ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics. Conflicts with
application_arn
. - bool
- (Optional) If set to
true
, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.
- application
Arn String - (Optional) Application ARN for an Amazon Pinpoint application. Conflicts with
external_id
androle_arn
. - application
Id String - (Optional) Application ID for an Amazon Pinpoint application.
- external
Id String - (Optional) ID for the Analytics Configuration. Conflicts with
application_arn
. - role
Arn String - (Optional) ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics. Conflicts with
application_arn
. - Boolean
- (Optional) If set to
true
, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.
- application
Arn string - (Optional) Application ARN for an Amazon Pinpoint application. Conflicts with
external_id
androle_arn
. - application
Id string - (Optional) Application ID for an Amazon Pinpoint application.
- external
Id string - (Optional) ID for the Analytics Configuration. Conflicts with
application_arn
. - role
Arn string - (Optional) ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics. Conflicts with
application_arn
. - boolean
- (Optional) If set to
true
, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.
- application_
arn str - (Optional) Application ARN for an Amazon Pinpoint application. Conflicts with
external_id
androle_arn
. - application_
id str - (Optional) Application ID for an Amazon Pinpoint application.
- external_
id str - (Optional) ID for the Analytics Configuration. Conflicts with
application_arn
. - role_
arn str - (Optional) ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics. Conflicts with
application_arn
. - bool
- (Optional) If set to
true
, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.
- application
Arn String - (Optional) Application ARN for an Amazon Pinpoint application. Conflicts with
external_id
androle_arn
. - application
Id String - (Optional) Application ID for an Amazon Pinpoint application.
- external
Id String - (Optional) ID for the Analytics Configuration. Conflicts with
application_arn
. - role
Arn String - (Optional) ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics. Conflicts with
application_arn
. - Boolean
- (Optional) If set to
true
, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.
GetUserPoolClientTokenValidityUnit
- Access
Token string - (Optional) Time unit in for the value in
access_token_validity
, defaults tohours
. - Id
Token string - (Optional) Time unit in for the value in
id_token_validity
, defaults tohours
. - Refresh
Token string - (Optional) Time unit in for the value in
refresh_token_validity
, defaults todays
.
- Access
Token string - (Optional) Time unit in for the value in
access_token_validity
, defaults tohours
. - Id
Token string - (Optional) Time unit in for the value in
id_token_validity
, defaults tohours
. - Refresh
Token string - (Optional) Time unit in for the value in
refresh_token_validity
, defaults todays
.
- access
Token String - (Optional) Time unit in for the value in
access_token_validity
, defaults tohours
. - id
Token String - (Optional) Time unit in for the value in
id_token_validity
, defaults tohours
. - refresh
Token String - (Optional) Time unit in for the value in
refresh_token_validity
, defaults todays
.
- access
Token string - (Optional) Time unit in for the value in
access_token_validity
, defaults tohours
. - id
Token string - (Optional) Time unit in for the value in
id_token_validity
, defaults tohours
. - refresh
Token string - (Optional) Time unit in for the value in
refresh_token_validity
, defaults todays
.
- access_
token str - (Optional) Time unit in for the value in
access_token_validity
, defaults tohours
. - id_
token str - (Optional) Time unit in for the value in
id_token_validity
, defaults tohours
. - refresh_
token str - (Optional) Time unit in for the value in
refresh_token_validity
, defaults todays
.
- access
Token String - (Optional) Time unit in for the value in
access_token_validity
, defaults tohours
. - id
Token String - (Optional) Time unit in for the value in
id_token_validity
, defaults tohours
. - refresh
Token String - (Optional) Time unit in for the value in
refresh_token_validity
, defaults todays
.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.