@propulsionworks/cloudformation 0.1.0 → 0.1.2

package/out/exports/resources.generated/aws-cognito-identitypool.d.ts

@@ -1,29 +1,41 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * The `AWS::Cognito::IdentityPool` resource creates an Amazon Cognito identity pool.
+ *
+ * To avoid deleting the resource accidentally from AWS CloudFormation , use [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) and the [UpdateReplacePolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html) to retain the resource on deletion or replacement.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html}
+ */
 export type CognitoIdentityPool = ResourceDefinitionWithAttributes<"AWS::Cognito::IdentityPool", CognitoIdentityPoolProps, CognitoIdentityPoolAttribs>;
 /**
  * The `AWS::Cognito::IdentityPool` resource creates an Amazon Cognito identity pool.
  *
  * To avoid deleting the resource accidentally from AWS CloudFormation , use [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) and the [UpdateReplacePolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html) to retain the resource on deletion or replacement.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html}
  */
 export type CognitoIdentityPoolProps = {
     /**
      * Enables the Basic (Classic) authentication flow.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-allowclassicflow}
      */
     AllowClassicFlow?: boolean | undefined;
     /**
      * Specifies whether the identity pool supports unauthenticated logins.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-allowunauthenticatedidentities}
      */
     AllowUnauthenticatedIdentities: boolean;
     /**
      * The events to configure.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-cognitoevents}
      */
     CognitoEvents?: Record<string, unknown> | undefined;
     /**
      * The Amazon Cognito user pools and their client IDs.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-cognitoidentityproviders}
      */
     CognitoIdentityProviders?: CognitoIdentityProvider[] | undefined;
     /**
      * Configuration options for configuring Amazon Cognito streams.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-cognitostreams}
      */
     CognitoStreams?: CognitoStreams | undefined;
     /**
@@ -32,6 +44,7 @@ export type CognitoIdentityPoolProps = {
      * *Minimum length* : 1
      *
      * *Maximum length* : 100
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-developerprovidername}
      */
     DeveloperProviderName?: string | undefined;
     /**
@@ -42,46 +55,62 @@ export type CognitoIdentityPoolProps = {
      * *Maximum length* : 128
      *
      * *Pattern* : `[\w\s+=,.@-]+`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-identitypoolname}
      */
     IdentityPoolName?: string | undefined;
     /**
      * Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-identitypooltags}
      */
     IdentityPoolTags?: Tag[] | undefined;
     /**
      * The Amazon Resource Names (ARNs) of the OpenID connect providers.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-openidconnectproviderarns}
      */
     OpenIdConnectProviderARNs?: string[] | undefined;
     /**
      * The configuration options to be applied to the identity pool.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-pushsync}
      */
     PushSync?: PushSync | undefined;
     /**
      * The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-samlproviderarns}
      */
     SamlProviderARNs?: string[] | undefined;
     /**
      * Key-value pairs that map provider names to provider app IDs.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-supportedloginproviders}
      */
     SupportedLoginProviders?: Record<string, unknown> | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#aws-resource-cognito-identitypool-return-values}
+ */
 export type CognitoIdentityPoolAttribs = {
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-id}
+     */
     Id: string;
     /**
      * The name of the Amazon Cognito identity pool, returned as a string.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-name}
      */
     Name: string;
 };
 /**
  * `CognitoIdentityProvider` is a property of the [AWS::Cognito::IdentityPool](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html) resource that represents an Amazon Cognito user pool and its client ID.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitoidentityprovider.html}
  */
 export type CognitoIdentityProvider = {
     /**
      * The client ID for the Amazon Cognito user pool.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitoidentityprovider.html#cfn-cognito-identitypool-cognitoidentityprovider-clientid}
      */
     ClientId: string;
     /**
      * The provider name for an Amazon Cognito user pool. For example: `cognito-idp.us-east-2.amazonaws.com/us-east-2_123456789` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitoidentityprovider.html#cfn-cognito-identitypool-cognitoidentityprovider-providername}
      */
     ProviderName: string;
     /**
@@ -90,36 +119,44 @@ export type CognitoIdentityProvider = {
      * After you set the `ServerSideTokenCheck` to TRUE for an identity pool, that identity pool checks with the integrated user pools to make sure the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.
      *
      * If the user is signed out or deleted, the identity pool returns a 400 Not Authorized error.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitoidentityprovider.html#cfn-cognito-identitypool-cognitoidentityprovider-serversidetokencheck}
      */
     ServerSideTokenCheck?: boolean | undefined;
 };
 /**
  * `CognitoStreams` is a property of the [AWS::Cognito::IdentityPool](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html) resource that defines configuration options for Amazon Cognito streams.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitostreams.html}
  */
 export type CognitoStreams = {
     /**
      * The Amazon Resource Name (ARN) of the role Amazon Cognito can assume to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke `PutRecord` on your Amazon Cognito stream.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitostreams.html#cfn-cognito-identitypool-cognitostreams-rolearn}
      */
     RoleArn?: string | undefined;
     /**
      * The name of the Amazon Cognito stream to receive updates. This stream must be in the developer's account and in the same Region as the identity pool.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitostreams.html#cfn-cognito-identitypool-cognitostreams-streamname}
      */
     StreamName?: string | undefined;
     /**
      * Status of the Amazon Cognito streams. Valid values are: `ENABLED` or `DISABLED` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitostreams.html#cfn-cognito-identitypool-cognitostreams-streamingstatus}
      */
     StreamingStatus?: string | undefined;
 };
 /**
  * `PushSync` is a property of the [AWS::Cognito::IdentityPool](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html) resource that defines the configuration options to be applied to an Amazon Cognito identity pool.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-pushsync.html}
  */
 export type PushSync = {
     /**
      * The ARNs of the Amazon SNS platform applications that could be used by clients.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-pushsync.html#cfn-cognito-identitypool-pushsync-applicationarns}
      */
     ApplicationArns?: string[] | undefined;
     /**
      * An IAM role configured to allow Amazon Cognito to call Amazon SNS on behalf of the developer.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-pushsync.html#cfn-cognito-identitypool-pushsync-rolearn}
      */
     RoleArn?: string | undefined;
 };

package/out/exports/resources.generated/aws-cognito-identitypoolprincipaltag.d.ts

@@ -1,23 +1,32 @@
 import type { ResourceDefinition } from "../main.ts";
+/**
+ * A list of the identity pool principal tag assignments for attributes for access control.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolprincipaltag.html}
+ */
 export type CognitoIdentityPoolPrincipalTag = ResourceDefinition<"AWS::Cognito::IdentityPoolPrincipalTag", CognitoIdentityPoolPrincipalTagProps>;
 /**
  * A list of the identity pool principal tag assignments for attributes for access control.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolprincipaltag.html}
  */
 export type CognitoIdentityPoolPrincipalTagProps = {
     /**
      * The identity pool that you want to associate with this principal tag map.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolprincipaltag.html#cfn-cognito-identitypoolprincipaltag-identitypoolid}
      */
     IdentityPoolId: string;
     /**
      * The identity pool identity provider (IdP) that you want to associate with this principal tag map.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolprincipaltag.html#cfn-cognito-identitypoolprincipaltag-identityprovidername}
      */
     IdentityProviderName: string;
     /**
      * A JSON-formatted list of user claims and the principal tags that you want to associate with them. When Amazon Cognito requests credentials, it sets the value of the principal tag to the value of the user's claim.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolprincipaltag.html#cfn-cognito-identitypoolprincipaltag-principaltags}
      */
     PrincipalTags?: Record<string, unknown> | undefined;
     /**
      * Use a default set of mappings between claims and tags for this provider, instead of a custom map.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolprincipaltag.html#cfn-cognito-identitypoolprincipaltag-usedefaults}
      */
     UseDefaults?: boolean | undefined;
 };

package/out/exports/resources.generated/aws-cognito-identitypoolroleattachment.d.ts

@@ -1,11 +1,17 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * The `AWS::Cognito::IdentityPoolRoleAttachment` resource manages the role configuration for an Amazon Cognito identity pool.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html}
+ */
 export type CognitoIdentityPoolRoleAttachment = ResourceDefinitionWithAttributes<"AWS::Cognito::IdentityPoolRoleAttachment", CognitoIdentityPoolRoleAttachmentProps, CognitoIdentityPoolRoleAttachmentAttribs>;
 /**
  * The `AWS::Cognito::IdentityPoolRoleAttachment` resource manages the role configuration for an Amazon Cognito identity pool.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html}
  */
 export type CognitoIdentityPoolRoleAttachmentProps = {
     /**
      * An identity pool ID in the format `REGION:GUID` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html#cfn-cognito-identitypoolroleattachment-identitypoolid}
      */
     IdentityPoolId: string;
     /**
@@ -14,73 +20,91 @@ export type CognitoIdentityPoolRoleAttachmentProps = {
      * If the `IdentityProvider` field isn't provided in this object, the string is used as the identity provider name.
      *
      * For more information, see the [RoleMapping property](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html#cfn-cognito-identitypoolroleattachment-rolemappings}
      */
     RoleMappings?: Record<string, RoleMapping> | undefined;
     /**
      * The map of the roles associated with this pool. For a given role, the key is either "authenticated" or "unauthenticated". The value is the role ARN.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html#cfn-cognito-identitypoolroleattachment-roles}
      */
     Roles?: Record<string, string> | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html#aws-resource-cognito-identitypoolroleattachment-return-values}
+ */
 export type CognitoIdentityPoolRoleAttachmentAttribs = {
     /**
      * The resource ID.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html#cfn-cognito-identitypoolroleattachment-id}
      */
     Id: string;
 };
 /**
  * Defines how to map a claim to a role ARN.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html}
  */
 export type MappingRule = {
     /**
      * The claim name that must be present in the token. For example: "isAdmin" or "paid".
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-claim}
      */
     Claim: string;
     /**
      * The match condition that specifies how closely the claim value in the IdP token must match `Value` .
      *
      * Valid values are: `Equals` , `Contains` , `StartsWith` , and `NotEqual` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-matchtype}
      */
     MatchType: string;
     /**
      * The Amazon Resource Name (ARN) of the role.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-rolearn}
      */
     RoleARN: string;
     /**
      * A brief string that the claim must match. For example, "paid" or "yes".
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-mappingrule.html#cfn-cognito-identitypoolroleattachment-mappingrule-value}
      */
     Value: string;
 };
 /**
  * One of a set of `RoleMappings` , a property of the [AWS::Cognito::IdentityPoolRoleAttachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html) resource that defines the role-mapping attributes of an Amazon Cognito identity pool.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html}
  */
 export type RoleMapping = {
     /**
      * If you specify Token or Rules as the `Type` , `AmbiguousRoleResolution` is required.
      *
      * Specifies the action to be taken if either no rules match the claim value for the `Rules` type, or there is no `cognito:preferred_role` claim and there are multiple `cognito:roles` matches for the `Token` type.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html#cfn-cognito-identitypoolroleattachment-rolemapping-ambiguousroleresolution}
      */
     AmbiguousRoleResolution?: string | undefined;
     /**
      * Identifier for the identity provider for which the role is mapped. For example: `graph.facebook.com` or `cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id (http://cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id)` . This is the identity provider that is used by the user for authentication.
      *
      * If the identity provider property isn't provided, the key of the entry in the `RoleMappings` map is used as the identity provider.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html#cfn-cognito-identitypoolroleattachment-rolemapping-identityprovider}
      */
     IdentityProvider?: string | undefined;
     /**
      * The rules to be used for mapping users to roles. If you specify "Rules" as the role-mapping type, RulesConfiguration is required.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html#cfn-cognito-identitypoolroleattachment-rolemapping-rulesconfiguration}
      */
     RulesConfiguration?: RulesConfigurationType | undefined;
     /**
      * The role mapping type. Token will use `cognito:roles` and `cognito:preferred_role` claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html#cfn-cognito-identitypoolroleattachment-rolemapping-type}
      */
     Type: string;
 };
 /**
  * `RulesConfigurationType` is a subproperty of the [RoleMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rolemapping.html) property that defines the rules to be used for mapping users to roles.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rulesconfigurationtype.html}
  */
 export type RulesConfigurationType = {
     /**
      * The rules. You can specify up to 25 rules per identity provider.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypoolroleattachment-rulesconfigurationtype.html#cfn-cognito-identitypoolroleattachment-rulesconfigurationtype-rules}
      */
     Rules: MappingRule[];
 };

package/out/exports/resources.generated/aws-cognito-logdeliveryconfiguration.d.ts

@@ -1,75 +1,98 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * Sets up or modifies the logging configuration of a user pool. User pools can export user notification logs and, when threat protection is active, user-activity logs. For more information, see [Exporting user pool logs](https://docs.aws.amazon.com/cognito/latest/developerguide/exporting-quotas-and-usage.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-logdeliveryconfiguration.html}
+ */
 export type CognitoLogDeliveryConfiguration = ResourceDefinitionWithAttributes<"AWS::Cognito::LogDeliveryConfiguration", CognitoLogDeliveryConfigurationProps, CognitoLogDeliveryConfigurationAttribs>;
 /**
  * Sets up or modifies the logging configuration of a user pool. User pools can export user notification logs and, when threat protection is active, user-activity logs. For more information, see [Exporting user pool logs](https://docs.aws.amazon.com/cognito/latest/developerguide/exporting-quotas-and-usage.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-logdeliveryconfiguration.html}
  */
 export type CognitoLogDeliveryConfigurationProps = {
     /**
      * A logging destination of a user pool. User pools can have multiple logging destinations for message-delivery and user-activity logs.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-logdeliveryconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfigurations}
      */
     LogConfigurations?: LogConfiguration[] | undefined;
     /**
      * The ID of the user pool where you configured logging.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-logdeliveryconfiguration.html#cfn-cognito-logdeliveryconfiguration-userpoolid}
      */
     UserPoolId: string;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-logdeliveryconfiguration.html#aws-resource-cognito-logdeliveryconfiguration-return-values}
+ */
 export type CognitoLogDeliveryConfigurationAttribs = {
     /**
      * A user pool ID, for example `us-east-1_EXAMPLE` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-logdeliveryconfiguration.html#cfn-cognito-logdeliveryconfiguration-id}
      */
     Id: string;
 };
 /**
  * Configuration for the CloudWatch log group destination of user pool detailed activity logging, or of user activity log export with advanced security features.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-cloudwatchlogsconfiguration.html}
  */
 export type CloudWatchLogsConfiguration = {
     /**
      * The Amazon Resource Name (arn) of a CloudWatch Logs log group where your user pool sends logs. The log group must not be encrypted with AWS Key Management Service and must be in the same AWS account as your user pool.
      *
      * To send logs to log groups with a resource policy of a size greater than 5120 characters, configure a log group with a path that starts with `/aws/vendedlogs` . For more information, see [Enabling logging from certain AWS services](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-cloudwatchlogsconfiguration.html#cfn-cognito-logdeliveryconfiguration-cloudwatchlogsconfiguration-loggrouparn}
      */
     LogGroupArn?: string | undefined;
 };
 /**
  * Configuration for the Amazon Data Firehose stream destination of user activity log export with threat protection.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-firehoseconfiguration.html}
  */
 export type FirehoseConfiguration = {
     /**
      * The ARN of an Amazon Data Firehose stream that's the destination for threat protection log export.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-firehoseconfiguration.html#cfn-cognito-logdeliveryconfiguration-firehoseconfiguration-streamarn}
      */
     StreamArn?: string | undefined;
 };
 /**
  * The configuration of user event logs to an external AWS service like Amazon Data Firehose, Amazon S3, or Amazon CloudWatch Logs.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html}
  */
 export type LogConfiguration = {
     /**
      * Configuration for the CloudWatch log group destination of user pool detailed activity logging, or of user activity log export with advanced security features.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfiguration-cloudwatchlogsconfiguration}
      */
     CloudWatchLogsConfiguration?: CloudWatchLogsConfiguration | undefined;
     /**
      * The source of events that your user pool sends for logging. To send error-level logs about user notification activity, set to `userNotification` . To send info-level logs about threat-protection user activity in user pools with the Plus feature plan, set to `userAuthEvents` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfiguration-eventsource}
      */
     EventSource?: string | undefined;
     /**
      * Configuration for the Amazon Data Firehose stream destination of user activity log export with threat protection.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfiguration-firehoseconfiguration}
      */
     FirehoseConfiguration?: FirehoseConfiguration | undefined;
     /**
      * The `errorlevel` selection of logs that a user pool sends for detailed activity logging. To send `userNotification` activity with [information about message delivery](https://docs.aws.amazon.com/cognito/latest/developerguide/exporting-quotas-and-usage.html) , choose `ERROR` with `CloudWatchLogsConfiguration` . To send `userAuthEvents` activity with user logs from threat protection with the Plus feature plan, choose `INFO` with one of `CloudWatchLogsConfiguration` , `FirehoseConfiguration` , or `S3Configuration` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfiguration-loglevel}
      */
     LogLevel?: string | undefined;
     /**
      * Configuration for the Amazon S3 bucket destination of user activity log export with threat protection.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-logconfiguration.html#cfn-cognito-logdeliveryconfiguration-logconfiguration-s3configuration}
      */
     S3Configuration?: S3Configuration | undefined;
 };
 /**
  * Configuration for the Amazon S3 bucket destination of user activity log export with threat protection.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-s3configuration.html}
  */
 export type S3Configuration = {
     /**
      * The ARN of an Amazon S3 bucket that's the destination for threat protection log export.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-logdeliveryconfiguration-s3configuration.html#cfn-cognito-logdeliveryconfiguration-s3configuration-bucketarn}
      */
     BucketArn?: string | undefined;
 };

package/out/exports/resources.generated/aws-cognito-managedloginbranding.d.ts

@@ -1,4 +1,14 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * Creates a new set of branding settings for a user pool style and associates it with an app client. This operation is the programmatic option for the creation of a new style in the branding designer.
+ *
+ * Provides values for UI customization in a `Settings` JSON object and image files in an `Assets` array. To send the JSON object `Document` type parameter in `Settings` , you might need to update to the most recent version of your AWS SDK.
+ *
+ * This operation has a 2-megabyte request-size limit and include the CSS settings and image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito doesn't require that you pass all parameters in one request and preserves existing style settings that you don't specify. If your request is larger than 2MB, separate it into multiple requests, each with a size smaller than the limit.
+ *
+ * As a best practice, modify the output of [DescribeManagedLoginBrandingByClient](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeManagedLoginBrandingByClient.html) into the request parameters for this operation. To get all settings, set `ReturnMergedResources` to `true` . For more information, see [API and SDK operations for managed login branding](https://docs.aws.amazon.com/cognito/latest/developerguide/managed-login-brandingdesigner.html#branding-designer-api)
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html}
+ */
 export type CognitoManagedLoginBranding = ResourceDefinitionWithAttributes<"AWS::Cognito::ManagedLoginBranding", CognitoManagedLoginBrandingProps, CognitoManagedLoginBrandingAttribs>;
 /**
  * Creates a new set of branding settings for a user pool style and associates it with an app client. This operation is the programmatic option for the creation of a new style in the branding designer.
@@ -8,67 +18,93 @@ export type CognitoManagedLoginBranding = ResourceDefinitionWithAttributes<"AWS:
  * This operation has a 2-megabyte request-size limit and include the CSS settings and image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito doesn't require that you pass all parameters in one request and preserves existing style settings that you don't specify. If your request is larger than 2MB, separate it into multiple requests, each with a size smaller than the limit.
  *
  * As a best practice, modify the output of [DescribeManagedLoginBrandingByClient](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeManagedLoginBrandingByClient.html) into the request parameters for this operation. To get all settings, set `ReturnMergedResources` to `true` . For more information, see [API and SDK operations for managed login branding](https://docs.aws.amazon.com/cognito/latest/developerguide/managed-login-brandingdesigner.html#branding-designer-api)
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html}
  */
 export type CognitoManagedLoginBrandingProps = {
     /**
      * An array of image files that you want to apply to roles like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html#cfn-cognito-managedloginbranding-assets}
      */
     Assets?: AssetType[] | undefined;
     /**
      * The app client that you want to assign the branding style to. Each style is linked to an app client until you delete it.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html#cfn-cognito-managedloginbranding-clientid}
      */
     ClientId?: string | undefined;
     /**
      * When `true` , returns values for branding options that are unchanged from Amazon Cognito defaults. When `false` or when you omit this parameter, returns only values that you customized in your branding style.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html#cfn-cognito-managedloginbranding-returnmergedresources}
      */
     ReturnMergedResources?: boolean | undefined;
     /**
      * A JSON file, encoded as a `Document` type, with the the settings that you want to apply to your style.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html#cfn-cognito-managedloginbranding-settings}
      */
     Settings?: Record<string, unknown> | undefined;
     /**
      * When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding editor.
      *
      * When you specify `true` for this option, you must also omit values for `Settings` and `Assets` in the request.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html#cfn-cognito-managedloginbranding-usecognitoprovidedvalues}
      */
     UseCognitoProvidedValues?: boolean | undefined;
     /**
      * The user pool where the branding style is assigned.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html#cfn-cognito-managedloginbranding-userpoolid}
      */
     UserPoolId: string;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html#aws-resource-cognito-managedloginbranding-return-values}
+ */
 export type CognitoManagedLoginBrandingAttribs = {
     /**
      * The ID of the managed login branding style.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-managedloginbranding.html#cfn-cognito-managedloginbranding-managedloginbrandingid}
      */
     ManagedLoginBrandingId: string;
 };
 /**
  * An image file from a managed login branding style in a user pool.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-managedloginbranding-assettype.html}
  */
 export type AssetType = {
     /**
      * The image file, in Base64-encoded binary.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-managedloginbranding-assettype.html#cfn-cognito-managedloginbranding-assettype-bytes}
      */
     Bytes?: string | undefined;
     /**
      * The category that the image corresponds to in your managed login configuration. Managed login has asset categories for different types of logos, backgrounds, and icons.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-managedloginbranding-assettype.html#cfn-cognito-managedloginbranding-assettype-category}
      */
     Category: CategoryType;
     /**
      * The display-mode target of the asset: light, dark, or browser-adaptive. For example, Amazon Cognito displays a dark-mode image only when the browser or application is in dark mode, but displays a browser-adaptive file in all contexts.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-managedloginbranding-assettype.html#cfn-cognito-managedloginbranding-assettype-colormode}
      */
     ColorMode: ColorModeType;
     /**
      * The file type of the image file.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-managedloginbranding-assettype.html#cfn-cognito-managedloginbranding-assettype-extension}
      */
     Extension: ExtensionType;
     /**
      * The ID of the asset.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-managedloginbranding-assettype.html#cfn-cognito-managedloginbranding-assettype-resourceid}
      */
     ResourceId?: string | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-managedloginbranding-categorytype.html}
+ */
 export type CategoryType = "FAVICON_ICO" | "FAVICON_SVG" | "EMAIL_GRAPHIC" | "SMS_GRAPHIC" | "AUTH_APP_GRAPHIC" | "PASSWORD_GRAPHIC" | "PASSKEY_GRAPHIC" | "PAGE_HEADER_LOGO" | "PAGE_HEADER_BACKGROUND" | "PAGE_FOOTER_LOGO" | "PAGE_FOOTER_BACKGROUND" | "PAGE_BACKGROUND" | "FORM_BACKGROUND" | "FORM_LOGO" | "IDP_BUTTON_ICON";
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-managedloginbranding-colormodetype.html}
+ */
 export type ColorModeType = "LIGHT" | "DARK" | "DYNAMIC";
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-managedloginbranding-extensiontype.html}
+ */
 export type ExtensionType = "ICO" | "JPEG" | "PNG" | "SVG" | "WEBP";
 //# sourceMappingURL=aws-cognito-managedloginbranding.d.ts.map