Skip to content

Commit f671912

Browse files
committed
docs: recreate README with latest terradoc
1 parent 9c4c174 commit f671912

File tree

1 file changed

+37
-37
lines changed

1 file changed

+37
-37
lines changed

README.md

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -372,11 +372,11 @@ For details please see the [attributes docs].
372372

373373
The object accepts the following attributes:
374374

375-
- [**`name`**](#attr-name-1): *(**Required** `string`)*<a name="attr-name-1"></a>
375+
- [**`name`**](#attr-name-account_recovery_mechanisms): *(**Required** `string`)*<a name="attr-name-account_recovery_mechanisms"></a>
376376

377377
Recovery method for a user. Can be of the following: verified_email, verified_phone_number, and admin_only.
378378

379-
- [**`priority`**](#attr-priority-1): *(**Required** `string`)*<a name="attr-priority-1"></a>
379+
- [**`priority`**](#attr-priority-account_recovery_mechanisms): *(**Required** `string`)*<a name="attr-priority-account_recovery_mechanisms"></a>
380380

381381
Positive integer specifying priority of a method with 1 being the highest priority.
382382

@@ -386,11 +386,11 @@ For details please see the [attributes docs].
386386

387387
The object accepts the following attributes:
388388

389-
- [**`external_id`**](#attr-external_id-1): *(**Required** `string`)*<a name="attr-external_id-1"></a>
389+
- [**`external_id`**](#attr-external_id-sms_configuration): *(**Required** `string`)*<a name="attr-external_id-sms_configuration"></a>
390390

391391
External ID used in IAM role trust relationships.
392392

393-
- [**`sns_caller_arn`**](#attr-sns_caller_arn-1): *(**Required** `string`)*<a name="attr-sns_caller_arn-1"></a>
393+
- [**`sns_caller_arn`**](#attr-sns_caller_arn-sms_configuration): *(**Required** `string`)*<a name="attr-sns_caller_arn-sms_configuration"></a>
394394

395395
ARN of the Amazon SNS caller. This is usually the IAM role that you've given Cognito permission to assume.
396396

@@ -491,25 +491,25 @@ For details please see the [attributes docs].
491491

492492
The object accepts the following attributes:
493493

494-
- [**`identifier`**](#attr-identifier-1): *(**Required** `string`)*<a name="attr-identifier-1"></a>
494+
- [**`identifier`**](#attr-identifier-resource_servers): *(**Required** `string`)*<a name="attr-identifier-resource_servers"></a>
495495

496496
An identifier for the resource server.
497497

498-
- [**`name`**](#attr-name-1): *(**Required** `string`)*<a name="attr-name-1"></a>
498+
- [**`name`**](#attr-name-resource_servers): *(**Required** `string`)*<a name="attr-name-resource_servers"></a>
499499

500500
A name for the resource server.
501501

502-
- [**`scope`**](#attr-scope-1): *(Optional `list(scope)`)*<a name="attr-scope-1"></a>
502+
- [**`scope`**](#attr-scope-resource_servers): *(Optional `list(scope)`)*<a name="attr-scope-resource_servers"></a>
503503

504504
A list of Authorization Scope.
505505

506506
The object accepts the following attributes:
507507

508-
- [**`scope_name`**](#attr-scope_name-2): *(**Required** `string`)*<a name="attr-scope_name-2"></a>
508+
- [**`scope_name`**](#attr-scope_name-scope-resource_servers): *(**Required** `string`)*<a name="attr-scope_name-scope-resource_servers"></a>
509509

510510
The scope name.
511511

512-
- [**`scope_description`**](#attr-scope_description-2): *(**Required** `string`)*<a name="attr-scope_description-2"></a>
512+
- [**`scope_description`**](#attr-scope_description-scope-resource_servers): *(**Required** `string`)*<a name="attr-scope_description-scope-resource_servers"></a>
513513

514514
The scope description.
515515

@@ -539,125 +539,125 @@ For details please see the [attributes docs].
539539

540540
The object accepts the following attributes:
541541

542-
- [**`name`**](#attr-name-1): *(**Required** `string`)*<a name="attr-name-1"></a>
542+
- [**`name`**](#attr-name-clients): *(**Required** `string`)*<a name="attr-name-clients"></a>
543543

544544
Name of the application client.
545545

546-
- [**`user_pool_id`**](#attr-user_pool_id-1): *(Optional `string`)*<a name="attr-user_pool_id-1"></a>
546+
- [**`user_pool_id`**](#attr-user_pool_id-clients): *(Optional `string`)*<a name="attr-user_pool_id-clients"></a>
547547

548548
Name of the application client.
549549

550-
- [**`access_token_validity`**](#attr-access_token_validity-1): *(Optional `number`)*<a name="attr-access_token_validity-1"></a>
550+
- [**`access_token_validity`**](#attr-access_token_validity-clients): *(Optional `number`)*<a name="attr-access_token_validity-clients"></a>
551551

552552
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.
553553

554-
- [**`allowed_oauth_flows_user_pool_client`**](#attr-allowed_oauth_flows_user_pool_client-1): *(Optional `bool`)*<a name="attr-allowed_oauth_flows_user_pool_client-1"></a>
554+
- [**`allowed_oauth_flows_user_pool_client`**](#attr-allowed_oauth_flows_user_pool_client-clients): *(Optional `bool`)*<a name="attr-allowed_oauth_flows_user_pool_client-clients"></a>
555555

556556
Whether the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
557557

558-
- [**`allowed_oauth_flows`**](#attr-allowed_oauth_flows-1): *(Optional `set(string)`)*<a name="attr-allowed_oauth_flows-1"></a>
558+
- [**`allowed_oauth_flows`**](#attr-allowed_oauth_flows-clients): *(Optional `set(string)`)*<a name="attr-allowed_oauth_flows-clients"></a>
559559

560560
List of allowed OAuth flows (code, implicit, client_credentials).
561561

562-
- [**`allowed_oauth_scopes`**](#attr-allowed_oauth_scopes-1): *(Optional `set(string)`)*<a name="attr-allowed_oauth_scopes-1"></a>
562+
- [**`allowed_oauth_scopes`**](#attr-allowed_oauth_scopes-clients): *(Optional `set(string)`)*<a name="attr-allowed_oauth_scopes-clients"></a>
563563

564564
List of allowed OAuth scopes (phone, email, openid, profile, and aws.cognito.signin.user.admin).
565565

566-
- [**`analytics_configuration`**](#attr-analytics_configuration-1): *(Optional `object(analytics_configuration)`)*<a name="attr-analytics_configuration-1"></a>
566+
- [**`analytics_configuration`**](#attr-analytics_configuration-clients): *(Optional `object(analytics_configuration)`)*<a name="attr-analytics_configuration-clients"></a>
567567

568568
Configuration block for Amazon Pinpoint analytics for collecting metrics for this user pool.
569569

570570
The object accepts the following attributes:
571571

572-
- [**`application_arn`**](#attr-application_arn-2): *(Optional `string`)*<a name="attr-application_arn-2"></a>
572+
- [**`application_arn`**](#attr-application_arn-analytics_configuration-clients): *(Optional `string`)*<a name="attr-application_arn-analytics_configuration-clients"></a>
573573

574574
Application ARN for an Amazon Pinpoint application. Conflicts with external_id and role_arn.
575575

576-
- [**`application_id`**](#attr-application_id-2): *(Optional `string`)*<a name="attr-application_id-2"></a>
576+
- [**`application_id`**](#attr-application_id-analytics_configuration-clients): *(Optional `string`)*<a name="attr-application_id-analytics_configuration-clients"></a>
577577

578578
Application ID for an Amazon Pinpoint application.
579579

580-
- [**`external_id`**](#attr-external_id-2): *(Optional `string`)*<a name="attr-external_id-2"></a>
580+
- [**`external_id`**](#attr-external_id-analytics_configuration-clients): *(Optional `string`)*<a name="attr-external_id-analytics_configuration-clients"></a>
581581

582582
ID for the Analytics Configuration. Conflicts with application_arn. Application ID for an Amazon Pinpoint application.
583583

584-
- [**`role_arn`**](#attr-role_arn-2): *(Optional `string`)*<a name="attr-role_arn-2"></a>
584+
- [**`role_arn`**](#attr-role_arn-analytics_configuration-clients): *(Optional `string`)*<a name="attr-role_arn-analytics_configuration-clients"></a>
585585

586586
ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics. Conflicts with application_arn.
587587

588-
- [**`user_data_shared`**](#attr-user_data_shared-2): *(Optional `bool`)*<a name="attr-user_data_shared-2"></a>
588+
- [**`user_data_shared`**](#attr-user_data_shared-analytics_configuration-clients): *(Optional `bool`)*<a name="attr-user_data_shared-analytics_configuration-clients"></a>
589589

590590
If set to true, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.
591591

592-
- [**`callback_urls`**](#attr-callback_urls-1): *(Optional `set(string)`)*<a name="attr-callback_urls-1"></a>
592+
- [**`callback_urls`**](#attr-callback_urls-clients): *(Optional `set(string)`)*<a name="attr-callback_urls-clients"></a>
593593

594594
List of allowed callback URLs for the identity providers.
595595

596-
- [**`default_redirect_uri`**](#attr-default_redirect_uri-1): *(Optional `string`)*<a name="attr-default_redirect_uri-1"></a>
596+
- [**`default_redirect_uri`**](#attr-default_redirect_uri-clients): *(Optional `string`)*<a name="attr-default_redirect_uri-clients"></a>
597597

598598
Default redirect URI. Must be in the list of callback URLs.
599599

600-
- [**`enable_token_revocation`**](#attr-enable_token_revocation-1): *(Optional `bool`)*<a name="attr-enable_token_revocation-1"></a>
600+
- [**`enable_token_revocation`**](#attr-enable_token_revocation-clients): *(Optional `bool`)*<a name="attr-enable_token_revocation-clients"></a>
601601

602602
Enables or disables token revocation.
603603

604-
- [**`explicit_auth_flows`**](#attr-explicit_auth_flows-1): *(Optional `set(string)`)*<a name="attr-explicit_auth_flows-1"></a>
604+
- [**`explicit_auth_flows`**](#attr-explicit_auth_flows-clients): *(Optional `set(string)`)*<a name="attr-explicit_auth_flows-clients"></a>
605605

606606
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).
607607

608-
- [**`generate_secret`**](#attr-generate_secret-1): *(Optional `bool`)*<a name="attr-generate_secret-1"></a>
608+
- [**`generate_secret`**](#attr-generate_secret-clients): *(Optional `bool`)*<a name="attr-generate_secret-clients"></a>
609609

610610
Should an application secret be generated.
611611

612-
- [**`id_token_validity`**](#attr-id_token_validity-1): *(Optional `number`)*<a name="attr-id_token_validity-1"></a>
612+
- [**`id_token_validity`**](#attr-id_token_validity-clients): *(Optional `number`)*<a name="attr-id_token_validity-clients"></a>
613613

614614
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.
615615

616-
- [**`logout_urls`**](#attr-logout_urls-1): *(Optional `set(string)`)*<a name="attr-logout_urls-1"></a>
616+
- [**`logout_urls`**](#attr-logout_urls-clients): *(Optional `set(string)`)*<a name="attr-logout_urls-clients"></a>
617617

618618
List of allowed logout URLs for the identity providers.
619619

620-
- [**`prevent_user_existence_errors`**](#attr-prevent_user_existence_errors-1): *(Optional `string`)*<a name="attr-prevent_user_existence_errors-1"></a>
620+
- [**`prevent_user_existence_errors`**](#attr-prevent_user_existence_errors-clients): *(Optional `string`)*<a name="attr-prevent_user_existence_errors-clients"></a>
621621

622622
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 to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.
623623

624-
- [**`read_attributes`**](#attr-read_attributes-1): *(Optional `set(string)`)*<a name="attr-read_attributes-1"></a>
624+
- [**`read_attributes`**](#attr-read_attributes-clients): *(Optional `set(string)`)*<a name="attr-read_attributes-clients"></a>
625625

626626
List of user pool attributes the application client can read from.
627627

628-
- [**`refresh_token_validity`**](#attr-refresh_token_validity-1): *(Optional `number`)*<a name="attr-refresh_token_validity-1"></a>
628+
- [**`refresh_token_validity`**](#attr-refresh_token_validity-clients): *(Optional `number`)*<a name="attr-refresh_token_validity-clients"></a>
629629

630630
Time limit in days refresh tokens are valid for.
631631

632-
- [**`supported_identity_providers`**](#attr-supported_identity_providers-1): *(Optional `set(string)`)*<a name="attr-supported_identity_providers-1"></a>
632+
- [**`supported_identity_providers`**](#attr-supported_identity_providers-clients): *(Optional `set(string)`)*<a name="attr-supported_identity_providers-clients"></a>
633633

634634
List of provider names for the identity providers that are supported on this client. Uses the provider_name attribute of aws_cognito_identity_provider resource(s), or the equivalent string(s).
635635

636-
- [**`token_validity_units`**](#attr-token_validity_units-1): *(Optional `object(token_validity_units)`)*<a name="attr-token_validity_units-1"></a>
636+
- [**`token_validity_units`**](#attr-token_validity_units-clients): *(Optional `object(token_validity_units)`)*<a name="attr-token_validity_units-clients"></a>
637637

638638
Configuration block for units in which the validity times are represented in.
639639

640640
The object accepts the following attributes:
641641

642-
- [**`access_token`**](#attr-access_token-2): *(Optional `string`)*<a name="attr-access_token-2"></a>
642+
- [**`access_token`**](#attr-access_token-token_validity_units-clients): *(Optional `string`)*<a name="attr-access_token-token_validity_units-clients"></a>
643643

644644
Time unit in for the value in access_token_validity, defaults to hours.
645645

646646
Default is `"hours"`.
647647

648-
- [**`id_token`**](#attr-id_token-2): *(Optional `string`)*<a name="attr-id_token-2"></a>
648+
- [**`id_token`**](#attr-id_token-token_validity_units-clients): *(Optional `string`)*<a name="attr-id_token-token_validity_units-clients"></a>
649649

650650
Time unit in for the value in id_token_validity, defaults to hours.
651651

652652
Default is `"hours"`.
653653

654-
- [**`refresh_token`**](#attr-refresh_token-2): *(Optional `string`)*<a name="attr-refresh_token-2"></a>
654+
- [**`refresh_token`**](#attr-refresh_token-token_validity_units-clients): *(Optional `string`)*<a name="attr-refresh_token-token_validity_units-clients"></a>
655655

656656
Time unit in for the value in refresh_token_validity, defaults to days.
657657

658658
Default is `"days"`.
659659

660-
- [**`write_attributes`**](#attr-write_attributes-1): *(Optional `set(string)`)*<a name="attr-write_attributes-1"></a>
660+
- [**`write_attributes`**](#attr-write_attributes-clients): *(Optional `set(string)`)*<a name="attr-write_attributes-clients"></a>
661661

662662
List of user pool attributes the application client can write to.
663663

0 commit comments

Comments
 (0)