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 #1295

Merged
merged 1 commit into from
Sep 13, 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/10842456205

------

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

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

Copy link

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

├[~] service aws-bedrock
│ └ resources
│    └[~] resource AWS::Bedrock::DataSource
│      └ types
│         ├[~] type BedrockFoundationModelConfiguration
│         │ ├  - documentation: Settings for a foundation model used to parse documents for a data source.
│         │ │  + documentation: Settings for a foundation model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) used to parse documents for a data source.
│         │ └ 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 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. 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.
├[~] service aws-ec2
│ └ resources
│    ├[~] resource AWS::EC2::LaunchTemplate
│    │ ├ properties
│    │ │  └ TagSpecifications: (documentation changed)
│    │ └ types
│    │    ├[~] type LaunchTemplateData
│    │    │ └ properties
│    │    │    └ TagSpecifications: (documentation changed)
│    │    ├[~] type LaunchTemplateTagSpecification
│    │    │ └  - documentation: Specifies the tags to apply to the launch template during creation.
│    │    │    `LaunchTemplateTagSpecification` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) .
│    │    │    + documentation: Specifies the tags to apply to the launch template during creation.
│    │    │    To specify the tags for the resources that are created during instance launch, use [AWS::EC2::LaunchTemplate TagSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-tagspecification.html) .
│    │    │    `LaunchTemplateTagSpecification` is a property of [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) .
│    │    └[~] type TagSpecification
│    │      └  - documentation: Specifies the tags to apply to a resource when the resource is created for the launch template.
│    │         `TagSpecification` is a property type of [`TagSpecifications`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) . [`TagSpecifications`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) .
│    │         + documentation: Specifies the tags to apply to resources that are created during instance launch.
│    │         `TagSpecification` is a property type of [`TagSpecifications`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) . [`TagSpecifications`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications) is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) .
│    └[~] resource AWS::EC2::VPNConnection
│      └ properties
│         ├ LocalIpv4NetworkCidr: (documentation changed)
│         ├ LocalIpv6NetworkCidr: (documentation changed)
│         ├ OutsideIpAddressType: (documentation changed)
│         ├ RemoteIpv4NetworkCidr: (documentation changed)
│         ├ RemoteIpv6NetworkCidr: (documentation changed)
│         ├ TransportTransitGatewayAttachmentId: (documentation changed)
│         └ TunnelInsideIpVersion: (documentation changed)
├[~] service aws-elasticloadbalancingv2
│ └ resources
│    └[~] resource AWS::ElasticLoadBalancingV2::Listener
│      └ types
│         └[~] type ListenerAttribute
│           ├  - documentation: undefined
│           │  + documentation: Information about a listener attribute.
│           └ properties
│              ├ Key: (documentation changed)
│              └ Value: (documentation changed)
├[~] service aws-lex
│ └ resources
│    └[~] resource AWS::Lex::Bot
│      └ types
│         ├[~] type BotLocale
│         │ └ properties
│         │    └ VoiceSettings: (documentation changed)
│         └[~] type VoiceSettings
│           └  - documentation: Defines settings for using an Amazon Polly voice to communicate with a user.
│              + documentation: Defines settings for using an Amazon Polly voice to communicate with a user.
│              Valid values include:
│              - `standard`
│              - `neural`
│              - `long-form`
│              - `generative`
└[~] service aws-sagemaker
  └ resources
     ├[~] resource AWS::SageMaker::Domain
     │ └ types
     │    ├[~] type AppLifecycleManagement
     │    │ ├  - documentation: undefined
     │    │ │  + documentation: Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications.
     │    │ └ properties
     │    │    └ IdleSettings: (documentation changed)
     │    ├[~] type CodeEditorAppSettings
     │    │ └ properties
     │    │    └ AppLifecycleManagement: (documentation changed)
     │    ├[~] type IdleSettings
     │    │ ├  - documentation: undefined
     │    │ │  + documentation: Settings related to idle shutdown of Studio applications.
     │    │ └ properties
     │    │    ├ IdleTimeoutInMinutes: (documentation changed)
     │    │    ├ LifecycleManagement: (documentation changed)
     │    │    ├ MaxIdleTimeoutInMinutes: (documentation changed)
     │    │    └ MinIdleTimeoutInMinutes: (documentation changed)
     │    └[~] type JupyterLabAppSettings
     │      └ properties
     │         └ AppLifecycleManagement: (documentation changed)
     ├[~] resource AWS::SageMaker::Space
     │ └ types
     │    ├[~] type SpaceAppLifecycleManagement
     │    │ ├  - documentation: undefined
     │    │ │  + documentation: Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications in a space.
     │    │ └ properties
     │    │    └ IdleSettings: (documentation changed)
     │    ├[~] type SpaceCodeEditorAppSettings
     │    │ └ properties
     │    │    └ AppLifecycleManagement: (documentation changed)
     │    ├[~] type SpaceIdleSettings
     │    │ ├  - documentation: undefined
     │    │ │  + documentation: Settings related to idle shutdown of Studio applications in a space.
     │    │ └ properties
     │    │    └ IdleTimeoutInMinutes: (documentation changed)
     │    └[~] type SpaceJupyterLabAppSettings
     │      └ properties
     │         └ AppLifecycleManagement: (documentation changed)
     └[~] resource AWS::SageMaker::UserProfile
       └ types
          ├[~] type AppLifecycleManagement
          │ ├  - documentation: undefined
          │ │  + documentation: Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications.
          │ └ properties
          │    └ IdleSettings: (documentation changed)
          ├[~] type CodeEditorAppSettings
          │ └ properties
          │    └ AppLifecycleManagement: (documentation changed)
          ├[~] type IdleSettings
          │ ├  - documentation: undefined
          │ │  + documentation: Settings related to idle shutdown of Studio applications.
          │ └ properties
          │    ├ IdleTimeoutInMinutes: (documentation changed)
          │    ├ LifecycleManagement: (documentation changed)
          │    ├ MaxIdleTimeoutInMinutes: (documentation changed)
          │    └ MinIdleTimeoutInMinutes: (documentation changed)
          └[~] type JupyterLabAppSettings
            └ properties
               └ AppLifecycleManagement: (documentation changed)

@aws-cdk-automation aws-cdk-automation added this pull request to the merge queue Sep 13, 2024
Merged via the queue into main with commit e00af5e Sep 13, 2024
11 checks passed
@aws-cdk-automation aws-cdk-automation deleted the update-source/documentation branch September 13, 2024 03:38
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