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

Merged
merged 1 commit into from
Jan 5, 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/7417606192

------

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

Signed-off-by: github-actions <[email protected]>
Copy link

github-actions bot commented Jan 5, 2024

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

Copy link

github-actions bot commented Jan 5, 2024

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

├[~] service aws-ec2
│ └ resources
│    └[~] resource AWS::EC2::Subnet
│      └ properties
│         ├ Ipv4IpamPoolId: (documentation changed)
│         ├ Ipv4NetmaskLength: (documentation changed)
│         ├ Ipv6IpamPoolId: (documentation changed)
│         └ Ipv6NetmaskLength: (documentation changed)
├[~] service aws-fis
│ └ resources
│    └[~] resource AWS::FIS::ExperimentTemplate
│      ├  - documentation: Specifies an experiment template.
│      │  An experiment template includes the following components:
│      │  - *Targets* : A target can be a specific resource in your AWS environment, or one or more resources that match criteria that you specify, for example, resources that have specific tags.
│      │  - *Actions* : The actions to carry out on the target. You can specify multiple actions, the duration of each action, and when to start each action during an experiment.
│      │  - *Stop conditions* : If a stop condition is triggered while an experiment is running, the experiment is automatically stopped. You can define a stop condition as a CloudWatch alarm.
│      │  For more information, see [Experiment templates](https://docs.aws.amazon.com/fis/latest/userguide/experiment-templates.html) in the *AWS Fault Injection Service User Guide* .
│      │  + documentation: Describes an experiment template.
│      └ types
│         ├[~] type ExperimentTemplateAction
│         │ └  - documentation: Specifies an action for an experiment template.
│         │    For more information, see [Actions](https://docs.aws.amazon.com/fis/latest/userguide/actions.html) in the *AWS Fault Injection Service User Guide* .
│         │    + documentation: Describes an action for an experiment template.
│         ├[~] type ExperimentTemplateLogConfiguration
│         │ ├  - documentation: Specifies the configuration for experiment logging.
│         │ │  For more information, see [Experiment logging](https://docs.aws.amazon.com/fis/latest/userguide/monitoring-logging.html) in the *AWS Fault Injection Service User Guide* .
│         │ │  + documentation: Describes the configuration for experiment logging.
│         │ └ properties
│         │    ├ CloudWatchLogsConfiguration: (documentation changed)
│         │    └ S3Configuration: (documentation changed)
│         ├[~] type ExperimentTemplateStopCondition
│         │ └  - documentation: Specifies a stop condition for an experiment template.
│         │    For more information, see [Stop conditions](https://docs.aws.amazon.com/fis/latest/userguide/stop-conditions.html) in the *AWS Fault Injection Service User Guide* .
│         │    + documentation: Describes a stop condition for an experiment template.
│         ├[~] type ExperimentTemplateTarget
│         │ ├  - documentation: Specifies a target for an experiment. You must specify at least one Amazon Resource Name (ARN) or at least one resource tag. You cannot specify both ARNs and tags.
│         │ │  For more information, see [Targets](https://docs.aws.amazon.com/fis/latest/userguide/targets.html) in the *AWS Fault Injection Service User Guide* .
│         │ │  + documentation: Describes a target for an experiment template.
│         │ └ properties
│         │    └ Parameters: (documentation changed)
│         └[~] type ExperimentTemplateTargetFilter
│           └  - documentation: Specifies a filter used for the target resource input in an experiment template.
│              For more information, see [Resource filters](https://docs.aws.amazon.com/fis/latest/userguide/targets.html#target-filters) in the *AWS Fault Injection Service User Guide* .
│              + documentation: Describes a filter used for the target resources in an experiment template.
├[~] service aws-iotsitewise
│ └ resources
│    └[~] resource AWS::IoTSiteWise::Gateway
│      └ types
│         ├[~] type GatewayPlatform
│         │ └ properties
│         │    └ GreengrassV2: (documentation changed)
│         └[~] type GreengrassV2
│           └  - documentation: Contains details for a gateway that runs on AWS IoT Greengrass V2. To create a gateway that runs on AWS IoT Greengrass V2, you must deploy the IoT SiteWise Edge component to your gateway device. Your [Greengrass device role](https://docs.aws.amazon.com/greengrass/v2/developerguide/device-service-role.html) must use the `AWSIoTSiteWiseEdgeAccess` policy. For more information, see [Using AWS IoT SiteWise at the edge](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/sw-gateways.html) in the *AWS IoT SiteWise User Guide* .
│              + documentation: Contains details for a gateway that runs on AWS IoT Greengrass V2 . To create a gateway that runs on AWS IoT Greengrass V2 , you must deploy the IoT SiteWise Edge component to your gateway device. Your [Greengrass device role](https://docs.aws.amazon.com/greengrass/v2/developerguide/device-service-role.html) must use the `AWSIoTSiteWiseEdgeAccess` policy. For more information, see [Using AWS IoT SiteWise at the edge](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/sw-gateways.html) in the *AWS IoT SiteWise User Guide* .
├[~] service aws-mediatailor
│ └ resources
│    └[~] resource AWS::MediaTailor::Channel
│      ├ properties
│      │  └ TimeShiftConfiguration: (documentation changed)
│      └ types
│         └[~] type TimeShiftConfiguration
│           ├  - documentation: <p>The configuration for time-shifted viewing.</p>
│           │  + documentation: The configuration for time-shifted viewing.
│           └ properties
│              └ MaxTimeDelaySeconds: (documentation changed)
├[~] service aws-networkmanager
│ └ resources
│    └[~] resource AWS::NetworkManager::Device
│      └ attributes
│         └ CreatedAt: (documentation changed)
└[~] service aws-pipes
  └ resources
     └[~] resource AWS::Pipes::Pipe
       └ types
          └[~] type PipeLogConfiguration
            └ properties
               └ IncludeExecutionData: (documentation changed)

@aws-cdk-automation aws-cdk-automation added this pull request to the merge queue Jan 5, 2024
Merged via the queue into main with commit c18d39f Jan 5, 2024
11 checks passed
@aws-cdk-automation aws-cdk-automation deleted the update-source/documentation branch January 5, 2024 03:36
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