Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(sources): update documentation #1289

Merged
merged 1 commit into from
Sep 11, 2024
Merged

feat(sources): update documentation #1289

merged 1 commit into from
Sep 11, 2024

Conversation

aws-cdk-automation
Copy link
Contributor

⚠️ This Pull Request updates daily and will overwrite all manual changes pushed to the branch

Updates the documentation source from upstream. See details in workflow run.

Automatically created by projen via the "update-source-documentation" workflow

feat(sources): update documentation
95d334d 
> ⚠️ This Pull Request updates daily and will overwrite **all** manual changes pushed to the branch

Updates the documentation source from upstream. See details in [workflow run].

[Workflow Run]: https://github.com/cdklabs/awscdk-service-spec/actions/runs/10804392121

------

*Automatically created by projen via the "update-source-documentation" workflow*

Signed-off-by: github-actions <github-actions@github.com>
@github-actions GitHub Actions
Copy link

To work on this Pull Request, please create a new branch and PR. This prevents your work from being deleted by the automation.

Run the following commands inside the repo:

gh co 1289
git switch -c fix-pr-1289 && git push -u origin HEAD
gh pr create -t "fix: PR #1289" --body "Fixes https://github.com/cdklabs/awscdk-service-spec/pull/1289"

@github-actions GitHub Actions
Copy link

@aws-cdk/aws-service-spec: Model database diff detected

├[~] service aws-amplify
│ └ resources
│    └[~] resource AWS::Amplify::App
│      ├ properties
│      │  └ CacheConfig: (documentation changed)
│      └ types
│         └[~] type CacheConfig
│           ├  - documentation: undefined
│           │  + documentation: Describes the cache configuration for an Amplify app.
│           │  For more information about how Amplify applies an optimal cache configuration for your app based on the type of content that is being served, see [Managing cache configuration](https://docs.aws.amazon.com/amplify/latest/userguide/managing-cache-configuration) in the *Amplify User guide* .
│           └ properties
│              └ Type: (documentation changed)
├[~] service aws-applicationsignals
│ └ resources
│    └[~] resource AWS::ApplicationSignals::ServiceLevelObjective
│      ├  - documentation: Creates or updates a service level objective (SLO), which can help you ensure that your critical business operations are meeting customer expectations. Use SLOs to set and track specific target levels for the reliability and availability of your applications and services. SLOs use service level indicators (SLIs) to calculate whether the application is performing at the level that you want.
│      │  Create an SLO to set a target for a service or operation’s availability or latency. CloudWatch measures this target frequently you can find whether it has been breached.
│      │  When you create an SLO, you set an *attainment goal* for it. An *attainment goal* is the ratio of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.
│      │  After you have created an SLO, you can retrieve error budget reports for it. An *error budget* is the number of periods or amount of time that your service can accumulate during an interval before your overall SLO budget health is breached and the SLO is considered to be unmet. for example, an SLO with a threshold that 99.95% of requests must be completed under 2000ms every month translates to an error budget of 21.9 minutes of downtime per month.
│      │  When you call this operation, Application Signals creates the *AWSServiceRoleForCloudWatchApplicationSignals* service-linked role, if it doesn't already exist in your account. This service- linked role has the following permissions:
│      │  - `xray:GetServiceGraph`
│      │  - `logs:StartQuery`
│      │  - `logs:GetQueryResults`
│      │  - `cloudwatch:GetMetricData`
│      │  - `cloudwatch:ListMetrics`
│      │  - `tag:GetResources`
│      │  - `autoscaling:DescribeAutoScalingGroups`
│      │  You can easily set SLO targets for your applications that are discovered by Application Signals, using critical metrics such as latency and availability. You can also set SLOs against any CloudWatch metric or math expression that produces a time series.
│      │  For more information about SLOs, see [Service level objectives (SLOs)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-ServiceLevelObjectives.html) .
│      │  + documentation: Creates or updates a service level objective (SLO), which can help you ensure that your critical business operations are meeting customer expectations. Use SLOs to set and track specific target levels for the reliability and availability of your applications and services. SLOs use service level indicators (SLIs) to calculate whether the application is performing at the level that you want.
│      │  Create an SLO to set a target for a service or operation’s availability or latency. CloudWatch measures this target frequently you can find whether it has been breached.
│      │  The target performance quality that is defined for an SLO is the *attainment goal* . An attainment goal is the percentage of time or requests that the SLI is expected to meet the threshold over each time interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.
│      │  When you create an SLO, you specify whether it is a *period-based SLO* or a *request-based SLO* . Each type of SLO has a different way of evaluating your application's performance against its attainment goal.
│      │  - A *period-based SLO* uses defined *periods* of time within a specified total time interval. For each period of time, Application Signals determines whether the application met its goal. The attainment rate is calculated as the `number of good periods/number of total periods` .
│      │  For example, for a period-based SLO, meeting an attainment goal of 99.9% means that within your interval, your application must meet its performance goal during at least 99.9% of the time periods.
│      │  - A *request-based SLO* doesn't use pre-defined periods of time. Instead, the SLO measures `number of good requests/number of total requests` during the interval. At any time, you can find the ratio of good requests to total requests for the interval up to the time stamp that you specify, and measure that ratio against the goal set in your SLO.
│      │  After you have created an SLO, you can retrieve error budget reports for it. An *error budget* is the amount of time or amount of requests that your application can be non-compliant with the SLO's goal, and still have your application meet the goal.
│      │  - For a period-based SLO, the error budget starts at a number defined by the highest number of periods that can fail to meet the threshold, while still meeting the overall goal. The *remaining error budget* decreases with every failed period that is recorded. The error budget within one interval can never increase.
│      │  For example, an SLO with a threshold that 99.95% of requests must be completed under 2000ms every month translates to an error budget of 21.9 minutes of downtime per month.
│      │  - For a request-based SLO, the remaining error budget is dynamic and can increase or decrease, depending on the ratio of good requests to total requests.
│      │  When you call this operation, Application Signals creates the *AWSServiceRoleForCloudWatchApplicationSignals* service-linked role, if it doesn't already exist in your account. This service- linked role has the following permissions:
│      │  - `xray:GetServiceGraph`
│      │  - `logs:StartQuery`
│      │  - `logs:GetQueryResults`
│      │  - `cloudwatch:GetMetricData`
│      │  - `cloudwatch:ListMetrics`
│      │  - `tag:GetResources`
│      │  - `autoscaling:DescribeAutoScalingGroups`
│      │  You can easily set SLO targets for your applications that are discovered by Application Signals, using critical metrics such as latency and availability. You can also set SLOs against any CloudWatch metric or math expression that produces a time series.
│      │  You cannot change from a period-based SLO to a request-based SLO, or change from a request-based SLO to a period-based SLO.
│      │  For more information about SLOs, see [Service level objectives (SLOs)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-ServiceLevelObjectives.html) .
│      ├ properties
│      │  └ RequestBasedSli: (documentation changed)
│      └ types
│         ├[~] type MonitoredRequestCountMetric
│         │ └ properties
│         │    ├ BadCountMetric: (documentation changed)
│         │    └ GoodCountMetric: (documentation changed)
│         ├[~] type RequestBasedSli
│         │ └ properties
│         │    ├ MetricThreshold: (documentation changed)
│         │    └ RequestBasedSliMetric: (documentation changed)
│         └[~] type RequestBasedSliMetric
│           └ properties
│              ├ KeyAttributes: (documentation changed)
│              ├ MetricType: (documentation changed)
│              ├ MonitoredRequestCountMetric: (documentation changed)
│              └ TotalRequestCountMetric: (documentation changed)
├[~] service aws-codebuild
│ └ resources
│    └[~] resource AWS::CodeBuild::Fleet
│      └ properties
│         ├ ComputeType: (documentation changed)
│         ├ EnvironmentType: (documentation changed)
│         ├ FleetVpcConfig: (documentation changed)
│         └ ImageId: (documentation changed)
├[~] service aws-cognito
│ └ resources
│    ├[~] resource AWS::Cognito::LogDeliveryConfiguration
│    │ ├  - documentation: The logging parameters of a user pool returned in response to `GetLogDeliveryConfiguration` .
│    │ │  + documentation: The logging parameters of a user pool, as returned in the response to a [GetLogDeliveryConfiguration](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetLogDeliveryConfiguration.html) request.
│    │ └ types
│    │    ├[~] type CloudWatchLogsConfiguration
│    │    │ └  - documentation: Configuration for the CloudWatch log group destination of user pool detailed activity logging, or of user activity log export with advanced security features.
│    │    │    + documentation: Configuration for the CloudWatch log group destination of user pool detailed activity logging, or of user activity log export with advanced security features.
│    │    │    This data type is a request parameter of [SetLogDeliveryConfiguration](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetLogDeliveryConfiguration.html) and a response parameter of [GetLogDeliveryConfiguration](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetLogDeliveryConfiguration.html) .
│    │    └[~] type LogConfiguration
│    │      ├  - documentation: The logging parameters of a user pool.
│    │      │  + documentation: The configuration of user event logs to an external AWS-service like Amazon Data Firehose, Amazon S3, or Amazon CloudWatch Logs.
│    │      │  This data type is a request parameter of [SetLogDeliveryConfiguration](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetLogDeliveryConfiguration.html) and a response parameter of [GetLogDeliveryConfiguration](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetLogDeliveryConfiguration.html) .
│    │      └ properties
│    │         └ CloudWatchLogsConfiguration: (documentation changed)
│    ├[~] resource AWS::Cognito::UserPool
│    │ ├ properties
│    │ │  ├ AdminCreateUserConfig: (documentation changed)
│    │ │  ├ LambdaConfig: (documentation changed)
│    │ │  ├ Policies: (documentation changed)
│    │ │  └ VerificationMessageTemplate: (documentation changed)
│    │ └ types
│    │    ├[~] type AdminCreateUserConfig
│    │    │ └ properties
│    │    │    ├ AllowAdminCreateUserOnly: (documentation changed)
│    │    │    └ UnusedAccountValidityDays: (documentation changed)
│    │    ├[~] type DeviceConfiguration
│    │    │ └  - documentation: The device-remembering configuration for a user pool. A [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) request returns a null value for this object when the user pool isn't configured to remember devices. When device remembering is active, you can remember a user's device with a [ConfirmDevice](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html) API request. Additionally. when the property `DeviceOnlyRememberedOnUserPrompt` is `true` , you must follow `ConfirmDevice` with an [UpdateDeviceStatus](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html) API request that sets the user's device to `remembered` or `not_remembered` .
│    │    │    To sign in with a remembered device, include `DEVICE_KEY` in the authentication parameters in your user's [InitiateAuth](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html) request. If your app doesn't include a `DEVICE_KEY` parameter, the [response](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html#API_InitiateAuth_ResponseSyntax) from Amazon Cognito includes newly-generated `DEVICE_KEY` and `DEVICE_GROUP_KEY` values under `NewDeviceMetadata` . Store these values to use in future device-authentication requests.
│    │    │    > When you provide a value for any property of `DeviceConfiguration` , you activate the device remembering for the user pool.
│    │    │    + documentation: The device-remembering configuration for a user pool. A [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) request returns a null value for this object when the user pool isn't configured to remember devices. When device remembering is active, you can remember a user's device with a [ConfirmDevice](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html) API request. Additionally. when the property `DeviceOnlyRememberedOnUserPrompt` is `true` , you must follow `ConfirmDevice` with an [UpdateDeviceStatus](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html) API request that sets the user's device to `remembered` or `not_remembered` .
│    │    │    To sign in with a remembered device, include `DEVICE_KEY` in the authentication parameters in your user's [InitiateAuth](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html) request. If your app doesn't include a `DEVICE_KEY` parameter, the [response](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html#API_InitiateAuth_ResponseSyntax) from Amazon Cognito includes newly-generated `DEVICE_KEY` and `DEVICE_GROUP_KEY` values under `NewDeviceMetadata` . Store these values to use in future device-authentication requests.
│    │    │    > When you provide a value for any property of `DeviceConfiguration` , you activate the device remembering for the user pool.
│    │    │    > 
│    │    │    > This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) .
│    │    ├[~] type InviteMessageTemplate
│    │    │ └  - documentation: The message template to be used for the welcome message to new users.
│    │    │    See also [Customizing User Invitation Messages](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization) .
│    │    │    + documentation: The template for the welcome message to new users.
│    │    │    See also [Customizing User Invitation Messages](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization) .
│    │    ├[~] type LambdaConfig
│    │    │ ├  - documentation: Specifies the configuration for AWS Lambda triggers.
│    │    │ │  + documentation: A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of user pool operations. Triggers can modify the outcome of the operations that invoked them.
│    │    │ │  This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) .
│    │    │ └ properties
│    │    │    ├ CreateAuthChallenge: (documentation changed)
│    │    │    ├ CustomMessage: (documentation changed)
│    │    │    ├ DefineAuthChallenge: (documentation changed)
│    │    │    ├ PostAuthentication: (documentation changed)
│    │    │    ├ PostConfirmation: (documentation changed)
│    │    │    ├ PreAuthentication: (documentation changed)
│    │    │    ├ PreSignUp: (documentation changed)
│    │    │    ├ PreTokenGeneration: (documentation changed)
│    │    │    ├ PreTokenGenerationConfig: (documentation changed)
│    │    │    ├ UserMigration: (documentation changed)
│    │    │    └ VerifyAuthChallengeResponse: (documentation changed)
│    │    ├[~] type NumberAttributeConstraints
│    │    │ └  - documentation: The minimum and maximum values of an attribute that is of the number data type.
│    │    │    + documentation: The minimum and maximum values of an attribute that is of the number type, for example `custom:age` .
│    │    │    This data type is part of [SchemaAttributeType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SchemaAttributeType.html) . It defines the length constraints on number-type attributes that you configure in [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and displays the length constraints of all number-type attributes in the response to [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html)
│    │    ├[~] type PasswordPolicy
│    │    │ ├  - documentation: The password policy type.
│    │    │ │  + documentation: The password policy settings for a user pool, including complexity, history, and length requirements.
│    │    │ │  This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) .
│    │    │ └ properties
│    │    │    ├ RequireLowercase: (documentation changed)
│    │    │    ├ RequireNumbers: (documentation changed)
│    │    │    ├ RequireSymbols: (documentation changed)
│    │    │    └ RequireUppercase: (documentation changed)
│    │    ├[~] type Policies
│    │    │ ├  - documentation: The policy associated with a user pool.
│    │    │ │  + documentation: A list of user pool policies. Contains the policy that sets password-complexity requirements.
│    │    │ │  This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) .
│    │    │ └ properties
│    │    │    └ PasswordPolicy: (documentation changed)
│    │    ├[~] type PreTokenGenerationConfig
│    │    │ └  - documentation: The properties of a pre token generation Lambda trigger.
│    │    │    + documentation: The properties of a pre token generation Lambda trigger.
│    │    │    This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) .
│    │    ├[~] type SchemaAttribute
│    │    │ └  - documentation: A list of the user attributes and their properties in your user pool. The attribute schema contains standard attributes, custom attributes with a `custom:` prefix, and developer attributes with a `dev:` prefix. For more information, see [User pool attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) .
│    │    │    Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.
│    │    │    + documentation: A list of the user attributes and their properties in your user pool. The attribute schema contains standard attributes, custom attributes with a `custom:` prefix, and developer attributes with a `dev:` prefix. For more information, see [User pool attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) .
│    │    │    Developer-only `dev:` attributes are a legacy feature of user pools, and are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.
│    │    │    This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) .
│    │    ├[~] type StringAttributeConstraints
│    │    │ └ properties
│    │    │    └ MinLength: (documentation changed)
│    │    ├[~] type UsernameConfiguration
│    │    │ └ properties
│    │    │    └ CaseSensitive: (documentation changed)
│    │    ├[~] type UserPoolAddOns
│    │    │ └  - documentation: User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to `AUDIT` . To configure automatic security responses to risky traffic to your user pool, set to `ENFORCED` .
│    │    │    For more information, see [Adding advanced security to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html) .
│    │    │    + documentation: User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to `AUDIT` . To configure automatic security responses to risky traffic to your user pool, set to `ENFORCED` .
│    │    │    For more information, see [Adding advanced security to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html) .
│    │    │    This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) .
│    │    └[~] type VerificationMessageTemplate
│    │      ├  - documentation: The template for verification messages.
│    │      │  + documentation: The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.
│    │      │  This data type is a request and response parameter of [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) and [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) , and a response parameter of [DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) .
│    │      └ properties
│    │         └ DefaultEmailOption: (documentation changed)
│    ├[~] resource AWS::Cognito::UserPoolClient
│    │ ├ properties
│    │ │  └ ReadAttributes: (documentation changed)
│    │ └ types
│    │    ├[~] type AnalyticsConfiguration
│    │    │ ├  - documentation: The Amazon Pinpoint analytics configuration necessary to collect metrics for a user pool.
│    │    │ │  > In Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
│    │    │ │  + documentation: The settings for Amazon Pinpoint analytics configuration. With an analytics configuration, your application can collect user-activity metrics for user notifications with a Amazon Pinpoint campaign.
│    │    │ │  Amazon Pinpoint isn't available in all AWS Regions. For a list of available Regions, see [Amazon Cognito and Amazon Pinpoint Region availability](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html#cognito-user-pools-find-region-mappings) .
│    │    │ │  This data type is a request parameter of [CreateUserPoolClient](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPoolClient.html) and [UpdateUserPoolClient](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPoolClient.html) , and a response parameter of [DescribeUserPoolClient](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html) .
│    │    │ └ properties
│    │    │    ├ ApplicationId: (documentation changed)
│    │    │    ├ ExternalId: (documentation changed)
│    │    │    └ RoleArn: (documentation changed)
│    │    └[~] type TokenValidityUnits
│    │      └ properties
│    │         ├ AccessToken: (documentation changed)
│    │         ├ IdToken: (documentation changed)
│    │         └ RefreshToken: (documentation changed)
│    ├[~] resource AWS::Cognito::UserPoolDomain
│    │ └ types
│    │    └[~] type CustomDomainConfigType
│    │      └  - documentation: The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
│    │         + documentation: The configuration for a hosted UI custom domain.
│    │         This data type is a request parameter of [CreateUserPoolDomain](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPoolDomain.html) and [UpdateUserPoolDomain](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPoolDomain.html) .
│    ├[~] resource AWS::Cognito::UserPoolResourceServer
│    │ └ types
│    │    └[~] type ResourceServerScopeType
│    │      ├  - documentation: A resource server scope.
│    │      │  + documentation: One custom scope associated with a user pool resource server. This data type is a member of `ResourceServerScopeType` . For more information, see [Scopes, M2M, and API authorization with resource servers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html) .
│    │      │  This data type is a request parameter of [CreateResourceServer](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateResourceServer.html) and a response parameter of [DescribeResourceServer](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeResourceServer.html) .
│    │      └ properties
│    │         ├ ScopeDescription: (documentation changed)
│    │         └ ScopeName: (documentation changed)
│    ├[~] resource AWS::Cognito::UserPoolRiskConfigurationAttachment
│    │ ├ properties
│    │ │  ├ AccountTakeoverRiskConfiguration: (documentation changed)
│    │ │  ├ CompromisedCredentialsRiskConfiguration: (documentation changed)
│    │ │  ├ RiskExceptionConfiguration: (documentation changed)
│    │ │  └ UserPoolId: (documentation changed)
│    │ └ types
│    │    ├[~] type AccountTakeoverActionsType
│    │    │ ├  - documentation: Account takeover actions type.
│    │    │ │  + documentation: A list of account-takeover actions for each level of risk that Amazon Cognito might assess with advanced security features.
│    │    │ │  This data type is a request parameter of [SetRiskConfiguration](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html) and a response parameter of [DescribeRiskConfiguration](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html) .
│    │    │ └ properties
│    │    │    ├ HighAction: (documentation changed)
│    │    │    ├ LowAction: (documentation changed)
│    │    │    └ MediumAction: (documentation changed)
│    │    ├[~] type AccountTakeoverActionType
│    │    │ ├  - documentation: Account takeover action type.
│    │    │ │  + documentation: The automated response to a risk level for adaptive authentication in full-function, or `ENFORCED` , mode. You can assign an action to each risk level that advanced security features evaluates.
│    │    │ │  This data type is a request parameter of [SetRiskConfiguration](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html) and a response parameter of [DescribeRiskConfiguration](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html) .
│    │    │ └ properties
│    │    │    ├ EventAction: (documentation changed)
│    │    │    └ Notify: (documentation changed)
│    │    ├[~] type AccountTakeoverRiskConfigurationType
│    │    │ ├  - documentation: Configuration for mitigation actions and notification for different levels of risk detected for a potential account takeover.
│    │    │ │  + documentation: The settings for automated responses and notification templates for adaptive authentication with advanced security features.
│    │    │ │  This data type is a request parameter of [SetRiskConfiguration](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html) and a response parameter of [DescribeRiskConfiguration](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html) .
│    │    │ └ properties
│    │    │    ├ Actions: (documentation changed)
│    │    │    └ NotifyConfiguration: (documentation changed)
│    │    ├[~] type CompromisedCredentialsActionsType
│    │    │ ├  - documentation: The compromised credentials actions type.
│    │    │ │  + documentation: Settings for user pool actions when Amazon Cognito detects compromised credentials with advanced security features in full-function `ENFORCED` mode.
│    │    │ │  This data type is a request parameter of [SetRiskConfiguration](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html) and a response parameter of [DescribeRiskConfiguration](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html) .
│    │    │ └ properties
│    │    │    └ EventAction: (documentation changed)
│    │    ├[~] type CompromisedCredentialsRiskConfigurationType
│    │    │ ├  - documentation: The compromised credentials risk configuration type.
│    │    │ │  + documentation: Settings for compromised-credentials actions and authentication-event sources with advanced security features in full-function `ENFORCED` mode.
│    │    │ │  This data type is a request parameter of [SetRiskConfiguration](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html) and a response parameter of [DescribeRiskConfiguration](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html) .
│    │    │ └ properties
│    │    │    ├ Actions: (documentation changed)
│    │    │    └ EventFilter: (documentation changed)
│    │    ├[~] type NotifyConfigurationType
│    │    │ ├  - documentation: The notify configuration type.
│    │    │ │  + documentation: The configuration for Amazon SES email messages that advanced security features sends to a user when your adaptive authentication automated response has a *Notify* action.
│    │    │ │  This data type is a request parameter of [SetRiskConfiguration](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html) and a response parameter of [DescribeRiskConfiguration](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html) .
│    │    │ └ properties
│    │    │    ├ BlockEmail: (documentation changed)
│    │    │    ├ From: (documentation changed)
│    │    │    ├ MfaEmail: (documentation changed)
│    │    │    ├ NoActionEmail: (documentation changed)
│    │    │    └ ReplyTo: (documentation changed)
│    │    ├[~] type NotifyEmailType
│    │    │ ├  - documentation: The notify email type.
│    │    │ │  + documentation: The template for email messages that advanced security features sends to a user when your threat protection automated response has a *Notify* action.
│    │    │ │  This data type is a request parameter of [SetRiskConfiguration](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html) and a response parameter of [DescribeRiskConfiguration](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html) .
│    │    │ └ properties
│    │    │    ├ HtmlBody: (documentation changed)
│    │    │    ├ Subject: (documentation changed)
│    │    │    └ TextBody: (documentation changed)
│    │    └[~] type RiskExceptionConfigurationType
│    │      ├  - documentation: The type of the configuration to override the risk decision.
│    │      │  + documentation: Exceptions to the risk evaluation configuration, including always-allow and always-block IP address ranges.
│    │      │  This data type is a request parameter of [SetRiskConfiguration](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html) and a response parameter of [DescribeRiskConfiguration](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html) .
│    │      └ properties
│    │         ├ BlockedIPRangeList: (documentation changed)
│    │         └ SkippedIPRangeList: (documentation changed)
│    └[~] resource AWS::Cognito::UserPoolUser
│      └ types
│         └[~] type AttributeType
│           └  - documentation: Specifies whether the attribute is standard or custom.
│              + documentation: The name and value of a user attribute.
│              This data type is a request parameter of [AdminUpdateUserAttributes](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html) and [UpdateUserAttributes](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html) .
├[~] service aws-logs
│ └ resources
│    └[~] resource AWS::Logs::Delivery
│      └  - documentation: This structure contains information about one *delivery* in your account.
│         A delivery is a connection between a logical *delivery source* and a logical *delivery destination* .
│         For more information, see [CreateDelivery](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html) .
│         You can't update an existing delivery. You can only create and delete deliveries.
│         + documentation: This structure contains information about one *delivery* in your account.
│         A delivery is a connection between a logical *delivery source* and a logical *delivery destination* .
│         For more information, see [CreateDelivery](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html) .
│         To update an existing delivery configuration, use [UpdateDeliveryConfiguration](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateDeliveryConfiguration.html) .
├[~] service aws-qbusiness
│ └ resources
│    └[~] resource AWS::QBusiness::Application
│      └ properties
│         └ RoleArn: (documentation changed)
└[~] service aws-sagemaker
  └ resources
     └[~] resource AWS::SageMaker::Cluster
       ├  - documentation: Resource Type definition for AWS::SageMaker::Cluster
       │  + documentation: Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing persistent clusters for developing large machine learning models, such as large language models (LLMs) and diffusion models. To learn more, see [Amazon SageMaker HyperPod](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod.html) in the *Amazon SageMaker Developer Guide* .
       ├ properties
       │  ├ ClusterName: (documentation changed)
       │  └ VpcConfig: (documentation changed)
       ├ attributes
       │  ├ ClusterArn: (documentation changed)
       │  ├ ClusterStatus: (documentation changed)
       │  └ CreationTime: (documentation changed)
       └ types
          ├[~] type ClusterEbsVolumeConfig
          │ ├  - documentation: Defines the configuration for attaching additional Amazon Elastic Block Store (EBS) volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.
          │ │  + documentation: Defines the configuration for attaching an additional Amazon Elastic Block Store (EBS) volume to each instance of the SageMaker HyperPod cluster instance group. To learn more, see [SageMaker HyperPod release notes: June 20, 2024](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-release-notes.html#sagemaker-hyperpod-release-notes-20240620) .
          │ └ properties
          │    └ VolumeSizeInGB: (documentation changed)
          ├[~] type ClusterInstanceStorageConfig
          │ ├  - documentation: Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group.
          │ │  + documentation: Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. To learn more, see [SageMaker HyperPod release notes: June 20, 2024](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-release-notes.html#sagemaker-hyperpod-release-notes-20240620) .
          │ └ properties
          │    └ EbsVolumeConfig: (documentation changed)
          ├[~] type ClusterLifeCycleConfig
          │ └ properties
          │    ├ OnCreate: (documentation changed)
          │    └ SourceS3Uri: (documentation changed)
          ├[~] type ClusterOrchestratorEksConfig
          │ ├  - documentation: Specifies parameter(s) related to EKS as orchestrator, e.g. the EKS cluster nodes will attach to,
          │ │  + documentation: The configuration settings for the Amazon EKS cluster used as the orchestrator for the SageMaker HyperPod cluster.
          │ └ properties
          │    └ ClusterArn: (documentation changed)
          └[~] type VpcConfig
            ├  - documentation: Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC.
            │  + documentation: Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see [Give SageMaker Access to Resources in your Amazon VPC](https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html) .
            └ properties
               ├ SecurityGroupIds: (documentation changed)
               └ Subnets: (documentation changed)

@aws-cdk-automation aws-cdk-automation added this pull request to the merge queue Sep 11, 2024
Merged via the queue into main with commit 9ea4e5e Sep 11, 2024
11 checks passed
@aws-cdk-automation aws-cdk-automation deleted the update-source/documentation branch September 11, 2024 03:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions github-actions[bot] github-actions[bot] approved these changes

Assignees
No one assigned
Labels
auto-approve
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@aws-cdk-automation