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.

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

feat(sources): update documentation #1486

Merged
merged 1 commit into from
Dec 10, 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

> ⚠️ 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/12248801659

------

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

Signed-off-by: github-actions <[email protected]>
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 1486
git switch -c fix-pr-1486 && git push -u origin HEAD
gh pr create -t "fix: PR #1486" --body "Fixes https://github.com/cdklabs/awscdk-service-spec/pull/1486"

Copy link

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

├[~] service aws-applicationautoscaling
│ └ resources
│    └[~] resource AWS::ApplicationAutoScaling::ScalingPolicy
│      └ types
│         └[~] type PredictiveScalingPolicyConfiguration
│           └  - documentation: Represents a predictive scaling policy configuration.
│              + documentation: Represents a predictive scaling policy configuration. Predictive scaling is supported on Amazon ECS services.
├[~] service aws-bedrock
│ └ resources
│    ├[~] resource AWS::Bedrock::DataSource
│    │ └ types
│    │    ├[~] type BedrockFoundationModelConfiguration
│    │    │ └ properties
│    │    │    └ ModelArn: (documentation changed)
│    │    ├[~] type ParsingConfiguration
│    │    │ ├  - documentation: Settings for parsing document contents. By default, the service converts the contents of each document into text before splitting it into chunks. To improve processing of PDF files with tables and images, you can configure the data source to convert the pages of text into images and use a model to describe the contents of each page.
│    │    │ │  To use a model to parse PDF documents, set the parsing strategy to `BEDROCK_FOUNDATION_MODEL` and specify the model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) to use by ARN. You can also override the default parsing prompt with instructions for how to interpret images and tables in your documents. The following models are supported.
│    │    │ │  - Anthropic Claude 3 Sonnet - `anthropic.claude-3-sonnet-20240229-v1:0`
│    │    │ │  - Anthropic Claude 3 Haiku - `anthropic.claude-3-haiku-20240307-v1:0`
│    │    │ │  You can get the ARN of a model with the [ListFoundationModels](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListFoundationModels.html) action. Standard model usage charges apply for the foundation model parsing strategy.
│    │    │ │  + documentation: Settings for parsing document contents. If you exclude this field, the default parser converts the contents of each document into text before splitting it into chunks. Specify the parsing strategy to use in the `parsingStrategy` field and include the relevant configuration, or omit it to use the Amazon Bedrock default parser. For more information, see [Parsing options for your data source](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-advanced-parsing.html) .
│    │    │ │  > If you specify `BEDROCK_DATA_AUTOMATION` or `BEDROCK_FOUNDATION_MODEL` and it fails to parse a file, the Amazon Bedrock default parser will be used instead.
│    │    │ └ properties
│    │    │    └ BedrockFoundationModelConfiguration: (documentation changed)
│    │    ├[~] type S3Location
│    │    │ ├  - documentation: An Amazon S3 location.
│    │    │ │  + documentation: A storage location in an S3 bucket.
│    │    │ └ properties
│    │    │    └ URI: (documentation changed)
│    │    └[~] type VectorIngestionConfiguration
│    │      └ properties
│    │         └ ParsingConfiguration: (documentation changed)
│    └[~] resource AWS::Bedrock::Guardrail
│      └ types
│         └[~] type PiiEntityConfig
│           └ properties
│              └ Type: (documentation changed)
├[~] service aws-cognito
│ └ resources
│    ├[~] resource AWS::Cognito::ManagedLoginBranding
│    │ ├  - documentation: 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)
│    │ │  > Amazon Cognito evaluates AWS Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
│    │ │  > 
│    │ │  > **Learn more** - [Signing AWS API Requests](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)
│    │ │  > - [Using the Amazon Cognito user pools API and user pool endpoints](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)
│    │ │  + documentation: 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)
│    │ └ properties
│    │    ├ ClientId: (documentation changed)
│    │    ├ ReturnMergedResources: (documentation changed)
│    │    └ UseCognitoProvidedValues: (documentation changed)
│    ├[~] resource AWS::Cognito::UserPool
│    │ ├ properties
│    │ │  ├ AliasAttributes: (documentation changed)
│    │ │  ├ AutoVerifiedAttributes: (documentation changed)
│    │ │  ├ DeviceConfiguration: (documentation changed)
│    │ │  ├ Schema: (documentation changed)
│    │ │  ├ SmsConfiguration: (documentation changed)
│    │ │  ├ UsernameConfiguration: (documentation changed)
│    │ │  ├ UserPoolName: (documentation changed)
│    │ │  ├ WebAuthnRelyingPartyID: (documentation changed)
│    │ │  └ WebAuthnUserVerification: (documentation changed)
│    │ └ types
│    │    ├[~] type AdvancedSecurityAdditionalFlows
│    │    │ ├  - documentation: undefined
│    │    │ │  + documentation: Advanced security configuration options for additional authentication types in your user pool, including custom authentication.
│    │    │ └ properties
│    │    │    └ CustomAuthMode: (documentation changed)
│    │    ├[~] type Policies
│    │    │ └ properties
│    │    │    └ SignInPolicy: (documentation changed)
│    │    ├[~] type SignInPolicy
│    │    │ ├  - documentation: undefined
│    │    │ │  + documentation: The policy for allowed types of authentication in a 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) .
│    │    │ └ properties
│    │    │    └ AllowedFirstAuthFactors: (documentation changed)
│    │    └[~] type UserPoolAddOns
│    │      └ properties
│    │         └ AdvancedSecurityAdditionalFlows: (documentation changed)
│    ├[~] resource AWS::Cognito::UserPoolClient
│    │ └ properties
│    │    ├ AllowedOAuthScopes: (documentation changed)
│    │    ├ AnalyticsConfiguration: (documentation changed)
│    │    ├ CallbackURLs: (documentation changed)
│    │    ├ ClientName: (documentation changed)
│    │    ├ DefaultRedirectURI: (documentation changed)
│    │    ├ GenerateSecret: (documentation changed)
│    │    ├ LogoutURLs: (documentation changed)
│    │    ├ SupportedIdentityProviders: (documentation changed)
│    │    ├ TokenValidityUnits: (documentation changed)
│    │    └ UserPoolId: (documentation changed)
│    ├[~] resource AWS::Cognito::UserPoolGroup
│    │ └ properties
│    │    ├ Description: (documentation changed)
│    │    ├ GroupName: (documentation changed)
│    │    ├ RoleArn: (documentation changed)
│    │    └ UserPoolId: (documentation changed)
│    ├[~] resource AWS::Cognito::UserPoolIdentityProvider
│    │ └ properties
│    │    ├ AttributeMapping: (documentation changed)
│    │    ├ IdpIdentifiers: (documentation changed)
│    │    ├ ProviderName: (documentation changed)
│    │    ├ ProviderType: (documentation changed)
│    │    └ UserPoolId: (documentation changed)
│    ├[~] resource AWS::Cognito::UserPoolResourceServer
│    │ └ properties
│    │    └ UserPoolId: (documentation changed)
│    ├[~] resource AWS::Cognito::UserPoolUICustomizationAttachment
│    │ └ properties
│    │    └ UserPoolId: (documentation changed)
│    ├[~] resource AWS::Cognito::UserPoolUser
│    │ └ properties
│    │    ├ ClientMetadata: (documentation changed)
│    │    ├ DesiredDeliveryMediums: (documentation changed)
│    │    ├ ForceAliasCreation: (documentation changed)
│    │    ├ MessageAction: (documentation changed)
│    │    └ UserPoolId: (documentation changed)
│    └[~] resource AWS::Cognito::UserPoolUserToGroupAttachment
│      └ properties
│         └ UserPoolId: (documentation changed)
├[~] service aws-ecs
│ └ resources
│    ├[~] resource AWS::ECS::Service
│    │ ├ properties
│    │ │  └ CapacityProviderStrategy: (documentation changed)
│    │ └ types
│    │    └[~] type DeploymentConfiguration
│    │      └ properties
│    │         ├ MaximumPercent: (documentation changed)
│    │         └ MinimumHealthyPercent: (documentation changed)
│    └[~] resource AWS::ECS::TaskSet
│      └ types
│         └[~] type CapacityProviderStrategyItem
│           └  - documentation: The details of a capacity provider strategy. A capacity provider strategy can be set when using the [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) or [CreateCluster](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html) APIs or as the default capacity provider strategy for a cluster with the `CreateCluster` API.
│              Only capacity providers that are already associated with a cluster and have an `ACTIVE` or `UPDATING` status can be used in a capacity provider strategy. The [PutClusterCapacityProviders](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html) API is used to associate a capacity provider with a cluster.
│              If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the [CreateClusterCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateClusterCapacityProvider.html) API operation.
│              To use a AWS Fargate capacity provider, specify either the `FARGATE` or `FARGATE_SPOT` capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used in a capacity provider strategy.
│              With `FARGATE_SPOT` , you can run interruption tolerant tasks at a rate that's discounted compared to the `FARGATE` price. `FARGATE_SPOT` runs tasks on spare compute capacity. When AWS needs the capacity back, your tasks are interrupted with a two-minute warning. `FARGATE_SPOT` supports Linux tasks with the X86_64 architecture on platform version 1.3.0 or later. `FARGATE_SPOT` supports Linux tasks with the ARM64 architecture on platform version 1.4.0 or later.
│              A capacity provider strategy may contain a maximum of 6 capacity providers.
│              + documentation: The details of a capacity provider strategy. A capacity provider strategy can be set when using the [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) or [CreateCluster](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html) APIs or as the default capacity provider strategy for a cluster with the `CreateCluster` API.
│              Only capacity providers that are already associated with a cluster and have an `ACTIVE` or `UPDATING` status can be used in a capacity provider strategy. The [PutClusterCapacityProviders](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html) API is used to associate a capacity provider with a cluster.
│              If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the [CreateClusterCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateClusterCapacityProvider.html) API operation.
│              To use a AWS Fargate capacity provider, specify either the `FARGATE` or `FARGATE_SPOT` capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used in a capacity provider strategy.
│              With `FARGATE_SPOT` , you can run interruption tolerant tasks at a rate that's discounted compared to the `FARGATE` price. `FARGATE_SPOT` runs tasks on spare compute capacity. When AWS needs the capacity back, your tasks are interrupted with a two-minute warning. `FARGATE_SPOT` supports Linux tasks with the X86_64 architecture on platform version 1.3.0 or later. `FARGATE_SPOT` supports Linux tasks with the ARM64 architecture on platform version 1.4.0 or later.
│              A capacity provider strategy can contain a maximum of 20 capacity providers.
├[~] service aws-efs
│ └ resources
│    └[~] resource AWS::EFS::FileSystem
│      └ types
│         └[~] type FileSystemProtection
│           └ properties
│              └ ReplicationOverwriteProtection: (documentation changed)
├[~] service aws-invoicing
│ └ resources
│    └[~] resource AWS::Invoicing::InvoiceUnit
│      ├  - documentation: An invoice unit is a set of mutually exclusive accounts that correspond to your business entity. Invoice units allow you to separate AWS account costs and configures your invoice for each business entity.
│      │  + documentation: An invoice unit is a set of mutually exclusive account that correspond to your business entity. Invoice units allow you separate AWS account costs and configures your invoice for each business entity going forward.
│      ├ properties
│      │  ├ Description: (documentation changed)
│      │  ├ InvoiceReceiver: (documentation changed)
│      │  ├ Name: (documentation changed)
│      │  ├ ResourceTags: (documentation changed)
│      │  ├ Rule: (documentation changed)
│      │  └ TaxInheritanceDisabled: (documentation changed)
│      ├ attributes
│      │  ├ InvoiceUnitArn: (documentation changed)
│      │  └ LastModified: (documentation changed)
│      └ types
│         ├[~] type ResourceTag
│         │ ├  - documentation: undefined
│         │ │  + documentation: The tag structure that contains a tag key and value.
│         │ └ properties
│         │    ├ Key: (documentation changed)
│         │    └ Value: (documentation changed)
│         └[~] type Rule
│           ├  - documentation: undefined
│           │  + documentation: The `InvoiceUnitRule` object used to update invoice units.
│           └ properties
│              └ LinkedAccounts: (documentation changed)
├[~] service aws-qbusiness
│ └ resources
│    ├[~] resource AWS::QBusiness::Application
│    │ └ properties
│    │    └ ClientIdsForOIDC: (documentation changed)
│    └[~] resource AWS::QBusiness::WebExperience
│      └ types
│         └[~] type IdentityProviderConfiguration
│           └ properties
│              ├ OpenIDConnectConfiguration: (documentation changed)
│              └ SamlConfiguration: (documentation changed)
├[~] service aws-rds
│ └ resources
│    └[~] resource AWS::RDS::DBCluster
│      └ properties
│         ├ AutoMinorVersionUpgrade: (documentation changed)
│         ├ MasterUserSecret: (documentation changed)
│         ├ MonitoringInterval: (documentation changed)
│         ├ MonitoringRoleArn: (documentation changed)
│         ├ PerformanceInsightsEnabled: (documentation changed)
│         ├ PerformanceInsightsKmsKeyId: (documentation changed)
│         └ PerformanceInsightsRetentionPeriod: (documentation changed)
└[~] service aws-ses
  └ resources
     └[~] resource AWS::SES::ReceiptRule
       └ types
          └[~] type ConnectAction
            ├  - documentation: undefined
            │  + documentation: When included in a receipt rule, this action parses the received message and starts an email contact in Amazon Connect on your behalf.
            │  > When you receive emails, the maximum email size (including headers) is 40 MB. Additionally, emails may only have up to 10 attachments. Emails larger than 40 MB or with more than 10 attachments will be bounced. 
            │  We recommend that you configure this action via Amazon Connect.
            └ properties
               ├ IAMRoleARN: (documentation changed)
               └ InstanceARN: (documentation changed)

@aws-cdk-automation aws-cdk-automation added this pull request to the merge queue Dec 10, 2024
Merged via the queue into main with commit 3291165 Dec 10, 2024
11 checks passed
@aws-cdk-automation aws-cdk-automation deleted the update-source/documentation branch December 10, 2024 03:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant