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

Merged
merged 1 commit into from
Oct 28, 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/11546728855

------

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

Copy link

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

├[~] service aws-codestar
│ └ resources
│    └[~] resource AWS::CodeStar::GitHubRepository
│      └  - documentation: The `AWS::CodeStar::GitHubRepository` resource creates a GitHub repository where users can store source code for use with AWS workflows. You must provide a location for the source code ZIP file in the AWS CloudFormation template, so the code can be uploaded to the created repository. You must have created a personal access token in GitHub to provide in the AWS CloudFormation template. AWS uses this token to connect to GitHub on your behalf. For more information about using a GitHub source repository with AWS CodeStar projects, see [AWS CodeStar Project Files and Resources](https://docs.aws.amazon.com/codestar/latest/userguide/templates.html#templates-whatis) .
│         + documentation: The `AWS::CodeStar::GitHubRepository` resource creates a GitHub repository where users can store source code for use with AWS workflows. You must provide a location for the source code ZIP file in the AWS CloudFormation template, so the code can be uploaded to the created repository. You must have created a personal access token in GitHub to provide in the AWS CloudFormation template. AWS uses this token to connect to GitHub on your behalf.
├[~] service aws-ec2
│ └ resources
│    └[~] resource AWS::EC2::LaunchTemplate
│      └ types
│         └[~] type NetworkInterface
│           └ properties
│              └ InterfaceType: (documentation changed)
├[~] service aws-ecs
│ └ resources
│    ├[~] resource AWS::ECS::Service
│    │ └ types
│    │    └[~] type ServiceManagedEBSVolumeConfiguration
│    │      ├  - documentation: The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service.
│    │      │  Many of these parameters map 1:1 with the Amazon EBS `CreateVolume` API request parameters.
│    │      │  + documentation: The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. For information about the supported launch types and operating systems, see [Supported operating systems and launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volumes-configuration) in the *Amazon Elastic Container Service Developer Guide* .
│    │      │  Many of these parameters map 1:1 with the Amazon EBS `CreateVolume` API request parameters.
│    │      └ properties
│    │         └ FilesystemType: (documentation changed)
│    └[~] resource AWS::ECS::TaskDefinition
│      └ types
│         └[~] type HealthCheck
│           └ properties
│              └ Command: (documentation changed)
├[~] service aws-elasticache
│ └ resources
│    ├[~] resource AWS::ElastiCache::GlobalReplicationGroup
│    │ └ properties
│    │    └ Engine: (documentation changed)
│    └[~] resource AWS::ElastiCache::ReplicationGroup
│      └ properties
│         └ Engine: (documentation changed)
├[~] service aws-emrserverless
│ └ resources
│    └[~] resource AWS::EMRServerless::Application
│      └ types
│         ├[~] type AutoStartConfiguration
│         │ ├  - documentation: Configuration for Auto Start of Application
│         │ │  + documentation: The configuration for an application to automatically start on job submission.
│         │ └ properties
│         │    └ Enabled: (documentation changed)
│         ├[~] type AutoStopConfiguration
│         │ ├  - documentation: Configuration for Auto Stop of Application
│         │ │  + documentation: The configuration for an application to automatically stop after a certain amount of time being idle.
│         │ └ properties
│         │    ├ Enabled: (documentation changed)
│         │    └ IdleTimeoutMinutes: (documentation changed)
│         ├[~] type ConfigurationObject
│         │ ├  - documentation: Configuration for a JobRun.
│         │ │  + documentation: A configuration specification to be used when provisioning an application. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file.
│         │ └ properties
│         │    ├ Classification: (documentation changed)
│         │    ├ Configurations: (documentation changed)
│         │    └ Properties: (documentation changed)
│         ├[~] type MonitoringConfiguration
│         │ └  - documentation: The configuration setting for monitoring.
│         │    + documentation: The configuration setting for monitoring logs.
│         └[~] type WorkerConfiguration
│           ├  - documentation: undefined
│           │  + documentation: The configuration of a worker. For more information, see [Supported worker configurations](https://docs.aws.amazon.com/emr/latest/EMR-Serverless-UserGuide/app-behavior.html#worker-configs) .
│           └ properties
│              ├ Cpu: (documentation changed)
│              ├ Disk: (documentation changed)
│              ├ DiskType: (documentation changed)
│              └ Memory: (documentation changed)
├[~] service aws-qbusiness
│ └ resources
│    ├[~] resource AWS::QBusiness::Application
│    │ └  - documentation: Creates an Amazon Q Business application.
│    │    > There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see [Amazon Q Business tiers](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#user-sub-tiers) . You must use the Amazon Q Business console to assign subscription tiers to users.
│    │    + documentation: Creates an Amazon Q Business application.
│    │    > There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see [Amazon Q Business tiers](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#user-sub-tiers) . You must use the Amazon Q Business console to assign subscription tiers to users.
│    │    > 
│    │    > A Amazon Q Apps service linked role will be created if it's absent in the AWS account when the QAppsConfiguration is enabled in the request. For more information, see [Using service-linked roles for Q Apps](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles-qapps.html)
│    └[~] resource AWS::QBusiness::WebExperience
│      └ properties
│         └ Origins: (documentation changed)
├[~] service aws-route53
│ └ resources
│    └[~] resource AWS::Route53::RecordSet
│      ├ properties
│      │  └ GeoProximityLocation: (documentation changed)
│      ├ attributes
│      │  └ Id: (documentation changed)
│      └ types
│         ├[~] type Coordinates
│         │ ├  - documentation: A complex type that lists the coordinates for a geoproximity resource record.
│         │ │  + documentation: undefined
│         │ └ properties
│         │    ├ Latitude: (documentation changed)
│         │    └ Longitude: (documentation changed)
│         └[~] type GeoProximityLocation
│           ├  - documentation: (Resource record sets only): A complex type that lets you specify where your resources are located. Only one of `LocalZoneGroup` , `Coordinates` , or `AWS Region` is allowed per request at a time.
│           │  For more information about geoproximity routing, see [Geoproximity routing](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy-geoproximity.html) in the *Amazon Route 53 Developer Guide* .
│           │  + documentation: undefined
│           └ properties
│              ├ AWSRegion: (documentation changed)
│              ├ Bias: (documentation changed)
│              ├ Coordinates: (documentation changed)
│              └ LocalZoneGroup: (documentation changed)
└[~] service aws-sagemaker
  └ resources
     ├[~] resource AWS::SageMaker::Domain
     │ ├ properties
     │ │  └ DefaultSpaceSettings: (documentation changed)
     │ └ types
     │    ├[~] type DefaultSpaceSettings
     │    │ └  - documentation: A collection of settings that apply to spaces created in the domain.
     │    │    + documentation: The default settings for shared spaces that users create in the domain.
     │    │    SageMaker applies these settings only to shared spaces. It doesn't apply them to private spaces.
     │    ├[~] type DomainSettings
     │    │ └ properties
     │    │    └ ExecutionRoleIdentityConfig: (documentation changed)
     │    └[~] type UserSettings
     │      └ properties
     │         ├ CodeEditorAppSettings: (documentation changed)
     │         ├ CustomFileSystemConfigs: (documentation changed)
     │         ├ CustomPosixUserConfig: (documentation changed)
     │         ├ ExecutionRole: (documentation changed)
     │         ├ JupyterLabAppSettings: (documentation changed)
     │         ├ SecurityGroups: (documentation changed)
     │         └ SpaceStorageSettings: (documentation changed)
     └[~] resource AWS::SageMaker::UserProfile
       └ types
          └[~] type UserSettings
            └ properties
               ├ CodeEditorAppSettings: (documentation changed)
               ├ CustomFileSystemConfigs: (documentation changed)
               ├ CustomPosixUserConfig: (documentation changed)
               ├ ExecutionRole: (documentation changed)
               ├ JupyterLabAppSettings: (documentation changed)
               ├ SecurityGroups: (documentation changed)
               └ SpaceStorageSettings: (documentation changed)

@aws-cdk-automation aws-cdk-automation added this pull request to the merge queue Oct 28, 2024
Merged via the queue into main with commit e407891 Oct 28, 2024
10 of 11 checks passed
@aws-cdk-automation aws-cdk-automation deleted the update-source/documentation branch October 28, 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