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

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

------

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

Copy link

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

├[~] service aws-bedrock
│ └ resources
│    ├[~] resource AWS::Bedrock::Agent
│    │ └ types
│    │    └[~] type PromptOverrideConfiguration
│    │      └ properties
│    │         └ OverrideLambda: (documentation changed)
│    └[~] resource AWS::Bedrock::Guardrail
│      └  - documentation: Creates a guardrail to block topics and to implement safeguards for your generative AI applications.
│         You can configure the following policies in a guardrail to avoid undesirable and harmful content, filter out denied topics and words, and remove sensitive information for privacy protection.
│         - *Content filters* - Adjust filter strengths to block input prompts or model responses containing harmful content.
│         - *Denied topics* - Define a set of topics that are undesirable in the context of your application. These topics will be blocked if detected in user queries or model responses.
│         - *Word filters* - Configure filters to block undesirable words, phrases, and profanity. Such words can include offensive terms, competitor names etc.
│         - *Sensitive information filters* - Block or mask sensitive information such as personally identifiable information (PII) or custom regex in user inputs and model responses.
│         In addition to the above policies, you can also configure the messages to be returned to the user if a user input or model response is in violation of the policies defined in the guardrail.
│         For more information, see [Guardrails for Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails.html) in the *Amazon Bedrock User Guide* .
│         + documentation: Creates a guardrail to block topics and to implement safeguards for your generative AI applications.
│         You can configure the following policies in a guardrail to avoid undesirable and harmful content, filter out denied topics and words, and remove sensitive information for privacy protection.
│         - *Content filters* - Adjust filter strengths to block input prompts or model responses containing harmful content.
│         - *Denied topics* - Define a set of topics that are undesirable in the context of your application. These topics will be blocked if detected in user queries or model responses.
│         - *Word filters* - Configure filters to block undesirable words, phrases, and profanity. Such words can include offensive terms, competitor names etc.
│         - *Sensitive information filters* - Block or mask sensitive information such as personally identifiable information (PII) or custom regex in user inputs and model responses.
│         In addition to the above policies, you can also configure the messages to be returned to the user if a user input or model response is in violation of the policies defined in the guardrail.
│         For more information, see [Amazon Bedrock Guardrails](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails.html) in the *Amazon Bedrock User Guide* .
├[~] service aws-ecs
│ └ resources
│    └[~] resource AWS::ECS::TaskDefinition
│      └ types
│         └[~] type ContainerDefinition
│           └ properties
│              └ Hostname: (documentation changed)
├[~] service aws-medialive
│ └ resources
│    ├[~] resource AWS::MediaLive::CloudWatchAlarmTemplate
│    │ ├ properties
│    │ │  └ TargetResourceType: (documentation changed)
│    │ └ attributes
│    │    ├ CreatedAt: (documentation changed)
│    │    ├ GroupId: (documentation changed)
│    │    ├ Id: (documentation changed)
│    │    └ ModifiedAt: (documentation changed)
│    ├[~] resource AWS::MediaLive::EventBridgeRuleTemplate
│    │ ├ properties
│    │ │  └ EventTargets: (documentation changed)
│    │ └ attributes
│    │    ├ Arn: (documentation changed)
│    │    ├ CreatedAt: (documentation changed)
│    │    ├ GroupId: (documentation changed)
│    │    ├ Id: (documentation changed)
│    │    └ ModifiedAt: (documentation changed)
│    └[~] resource AWS::MediaLive::SignalMap
│      ├ properties
│      │  ├ CloudWatchAlarmTemplateGroupIdentifiers: (documentation changed)
│      │  ├ DiscoveryEntryPointArn: (documentation changed)
│      │  └ EventBridgeRuleTemplateGroupIdentifiers: (documentation changed)
│      ├ attributes
│      │  ├ CloudWatchAlarmTemplateGroupIds: (documentation changed)
│      │  ├ CreatedAt: (documentation changed)
│      │  ├ EventBridgeRuleTemplateGroupIds: (documentation changed)
│      │  ├ LastDiscoveredAt: (documentation changed)
│      │  ├ ModifiedAt: (documentation changed)
│      │  └ Status: (documentation changed)
│      └ types
│         ├[~] type MediaResource
│         │ ├  - documentation: An AWS resource used in media workflows.
│         │ │  + documentation: An Amazon Web Services resource used in media workflows.
│         │ └ properties
│         │    ├ Destinations: (documentation changed)
│         │    ├ Name: (documentation changed)
│         │    └ Sources: (documentation changed)
│         ├[~] type MediaResourceNeighbor
│         │ ├  - documentation: A direct source or destination neighbor to an AWS media resource.
│         │ │  + documentation: A direct source or destination neighbor to an Amazon Web Services media resource.
│         │ └ properties
│         │    ├ Arn: (documentation changed)
│         │    └ Name: (documentation changed)
│         └[~] type MonitorDeployment
│           └ properties
│              └ Status: (documentation changed)
├[~] service aws-qbusiness
│ └ resources
│    └[~] resource AWS::QBusiness::DataSource
│      └ properties
│         └ Configuration: (documentation changed)
├[~] service aws-sagemaker
│ └ resources
│    └[~] resource AWS::SageMaker::Cluster
│      ├ properties
│      │  ├ NodeRecovery: (documentation changed)
│      │  ├ Orchestrator: (documentation changed)
│      │  └ Tags: (documentation changed)
│      ├ attributes
│      │  └ FailureMessage: (documentation changed)
│      └ types
│         ├[~] type ClusterInstanceGroup
│         │ ├  - documentation: Details of an instance group in a SageMaker HyperPod cluster.
│         │ │  + documentation: The configuration information of the instance group within the HyperPod cluster.
│         │ └ properties
│         │    ├ InstanceCount: (documentation changed)
│         │    ├ InstanceStorageConfigs: (documentation changed)
│         │    ├ OnStartDeepHealthChecks: (documentation changed)
│         │    └ ThreadsPerCore: (documentation changed)
│         ├[~] type ClusterOrchestratorEksConfig
│         │ ├  - documentation: The configuration settings for the Amazon EKS cluster used as the orchestrator for the SageMaker HyperPod cluster.
│         │ │  + documentation: The configuration for the Amazon EKS cluster that is used as the orchestrator for the SageMaker HyperPod cluster. This includes the Amazon Resource Name (ARN) of the EKS cluster
│         │ └ properties
│         │    └ ClusterArn: (documentation changed)
│         └[~] type Orchestrator
│           ├  - documentation: Specifies parameter(s) specific to the orchestrator, e.g. specify the EKS cluster.
│           │  + documentation: The orchestrator for a SageMaker HyperPod cluster.
│           └ properties
│              └ Eks: (documentation changed)
├[~] service aws-servicediscovery
│ └ resources
│    └[~] resource AWS::ServiceDiscovery::Service
│      └ types
│         └[~] type DnsConfig
│           └  - documentation: A complex type that contains information about the Amazon Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
│              > The record types of a service can only be changed by deleting the service and recreating it with a new `Dnsconfig` .
│              + documentation: A complex type that contains information about the Amazon Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
└[~] service aws-ssm
  └ resources
     ├[~] resource AWS::SSM::MaintenanceWindowTask
     │ ├ properties
     │ │  └ ServiceRoleArn: (documentation changed)
     │ └ types
     │    └[~] type MaintenanceWindowRunCommandParameters
     │      └ properties
     │         └ ServiceRoleArn: (documentation changed)
     └[~] resource AWS::SSM::PatchBaseline
       └ properties
          ├ ApprovedPatches: (documentation changed)
          └ RejectedPatches: (documentation changed)

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