CIMDPolicyType
The configuration of a Client ID Metadata Document (CIMD) policy, including its app client, name, cache duration, and URL patterns.
Contents
- CIMDPolicyId
-
The ID of the CIMD policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-z0-9]+$Required: Yes
- PolicyName
-
The friendly name of the CIMD policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}\p{Z}]+Required: Yes
- UserPoolId
-
The ID of the user pool that contains the CIMD policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+_[0-9a-zA-Z]+Required: Yes
- CacheDuration
-
The length of time, in seconds, that Amazon Cognito caches a client metadata document when the document's
Cache-Controlheader doesn't set amax-agebetween one day and one year. When the header sets amax-agein that range, Amazon Cognito uses the header value instead.Type: Integer
Valid Range: Minimum value of 86400. Maximum value of 31556952.
Required: No
- ClientId
-
The ID of the app client that the CIMD policy is associated with. Amazon Cognito omits this value when the app client no longer exists.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w+]+Required: No
- CreationDate
-
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java
Dateobject.Type: Timestamp
Required: No
- LastModifiedDate
-
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java
Dateobject.Type: Timestamp
Required: No
- URLPatterns
-
The HTTPS URL patterns that a client ID metadata document URL must match. Each pattern contains at most one
*wildcard.Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Length Constraints: Minimum length of 12. Maximum length of 256.
Pattern:
^https://[!$-;=@-\[\]_a-z~]+$Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: