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

Merged
merged 1 commit into from
Feb 29, 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/8090527176

------

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

Copy link

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

├[~] service aws-amplify
│ └ resources
│    └[~] resource AWS::Amplify::Domain
│      ├ properties
│      │  ├ Certificate: (documentation changed)
│      │  ├ CertificateSettings: (documentation changed)
│      │  └ UpdateStatus: (documentation changed)
│      └ types
│         ├[~] type Certificate
│         │ ├  - documentation: undefined
│         │ │  + documentation: Describes the SSL/TLS certificate for the domain association. This can be your own custom certificate or the default certificate that Amplify provisions for you.
│         │ │  If you are updating your domain to use a different certificate, `Certificate` points to the new certificate that is being created instead of the current active certificate. Otherwise, `Certificate` points to the current active certificate.
│         │ └ properties
│         │    ├ CertificateArn: (documentation changed)
│         │    ├ CertificateType: (documentation changed)
│         │    └ CertificateVerificationDNSRecord: (documentation changed)
│         └[~] type CertificateSettings
│           ├  - documentation: undefined
│           │  + documentation: The type of SSL/TLS certificate to use for your custom domain. If a certificate type isn't specified, Amplify uses the default `AMPLIFY_MANAGED` certificate.
│           └ properties
│              ├ CertificateType: (documentation changed)
│              └ CustomCertificateArn: (documentation changed)
├[~] service aws-cloudwatch
│ └ resources
│    └[~] resource AWS::CloudWatch::CompositeAlarm
│      └  - documentation: The `AWS::CloudWatch::CompositeAlarm` type creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.
│         The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.
│         Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.
│         Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics.
│         When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA state.
│         When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
│         + documentation: The `AWS::CloudWatch::CompositeAlarm` type creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.
│         The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.
│         Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.
│         When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA state.
│         When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
└[~] service aws-kinesisfirehose
  └ resources
     └[~] resource AWS::KinesisFirehose::DeliveryStream
       └ types
          └[~] type ExtendedS3DestinationConfiguration
            └ properties
               ├ CustomTimeZone: (documentation changed)
               └ FileExtension: (documentation changed)

@aws-cdk-automation aws-cdk-automation added this pull request to the merge queue Feb 29, 2024
Merged via the queue into main with commit 37af40b Feb 29, 2024
11 checks passed
@aws-cdk-automation aws-cdk-automation deleted the update-source/documentation branch February 29, 2024 03:37
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