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

Merged
merged 1 commit into from
Nov 17, 2023

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/6899449319

------

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

Copy link

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

├[~] service aws-applicationautoscaling
│ └ resources
│    └[~] resource AWS::ApplicationAutoScaling::ScalingPolicy
│      └ types
│         ├[~] type TargetTrackingMetric
│         │ ├  - documentation: Represents a specific metric.
│         │ │  Metric is a property of the `TargetTrackingMetricStat` object.
│         │ │  + documentation: Represents a specific metric.
│         │ └ properties
│         │    ├ Dimensions: (documentation changed)
│         │    └ Namespace: (documentation changed)
│         ├[~] type TargetTrackingMetricDataQuery
│         │ ├  - documentation: The metric data to return. Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp.
│         │ │  You can use `TargetTrackingMetricDataQuery` structures with a `PutScalingPolicy` operation when you specify a `TargetTrackingScalingPolicyConfiguration` in the request.
│         │ │  You can call for a single metric or perform math expressions on multiple metrics. Any expressions used in a metric specification must eventually return a single time series.
│         │ │  For more information and examples, see [Create a target tracking scaling policy for Application Auto Scaling using metric math](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking-metric-math.html) in the *Application Auto Scaling User Guide* .
│         │ │  + documentation: The metric data to return. Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp.
│         │ └ properties
│         │    ├ Expression: (documentation changed)
│         │    ├ Id: (documentation changed)
│         │    ├ MetricStat: (documentation changed)
│         │    └ ReturnData: (documentation changed)
│         └[~] type TargetTrackingMetricStat
│           ├  - documentation: This structure defines the CloudWatch metric to return, along with the statistic, period, and unit.
│           │  `TargetTrackingMetricStat` is a property of the `TargetTrackingMetricDataQuery` object.
│           │  For more information about the CloudWatch terminology below, see [Amazon CloudWatch concepts](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html) in the *Amazon CloudWatch User Guide* .
│           │  + documentation: This structure defines the CloudWatch metric to return, along with the statistic, period, and unit.
│           └ properties
│              ├ Metric: (documentation changed)
│              ├ Stat: (documentation changed)
│              └ Unit: (documentation changed)
├[~] service aws-autoscaling
│ └ resources
│    └[~] resource AWS::AutoScaling::AutoScalingGroup
│      ├ properties
│      │  └ InstanceMaintenancePolicy: (documentation changed)
│      └ types
│         └[~] type InstanceMaintenancePolicy
│           ├  - documentation: undefined
│           │  + documentation: `InstanceMaintenancePolicy` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.
│           │  For more information, see [Instance maintenance policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide* .
│           └ properties
│              ├ MaxHealthyPercentage: (documentation changed)
│              └ MinHealthyPercentage: (documentation changed)
├[~] service aws-dms
│ └ resources
│    └[~] resource AWS::DMS::ReplicationConfig
│      └ types
│         └[~] type ComputeConfig
│           └ properties
│              └ MinCapacityUnits: (documentation changed)
├[~] service aws-gamelift
│ └ resources
│    ├[~] resource AWS::GameLift::Build
│    │ ├ attributes
│    │ │  └ BuildId: (documentation changed)
│    │ └ types
│    │    └[~] type StorageLocation
│    │      └ properties
│    │         ├ Bucket: (documentation changed)
│    │         ├ ObjectVersion: (documentation changed)
│    │         └ RoleArn: (documentation changed)
│    ├[~] resource AWS::GameLift::Fleet
│    │ ├ properties
│    │ │  ├ AnywhereConfiguration: (documentation changed)
│    │ │  ├ ComputeType: (documentation changed)
│    │ │  └ ScalingPolicies: (documentation changed)
│    │ └ types
│    │    └[~] type ServerProcess
│    │      └ properties
│    │         └ Parameters: (documentation changed)
│    ├[~] resource AWS::GameLift::GameSessionQueue
│    │ └ types
│    │    ├[~] type Destination
│    │    │ ├  - documentation: A fleet or alias designated in a game session queue. Queues fulfill requests for new game sessions by placing a new game session on any of the queue's destinations.
│    │    │ │  + documentation: undefined
│    │    │ └ properties
│    │    │    └ DestinationArn: (documentation changed)
│    │    └[~] type GameSessionQueueDestination
│    │      ├  - documentation: A fleet or alias designated in a game session queue.
│    │      │  + documentation: A fleet or alias designated in a game session queue. Queues fulfill requests for new game sessions by placing a new game session on any of the queue's destinations.
│    │      └ properties
│    │         └ DestinationArn: (documentation changed)
│    ├[~] resource AWS::GameLift::Location
│    │ ├  - documentation: Creates a custom location for use in an Anywhere fleet.
│    │ │  + documentation: The AWS::GameLift::Location resource creates a custom location for use in an Anywhere fleet.
│    │ ├ properties
│    │ │  ├ LocationName: (documentation changed)
│    │ │  └ Tags: (documentation changed)
│    │ └ attributes
│    │    └ LocationArn: (documentation changed)
│    ├[~] resource AWS::GameLift::MatchmakingConfiguration
│    │ └ properties
│    │    ├ CreationTime: (documentation changed)
│    │    └ RuleSetArn: (documentation changed)
│    ├[~] resource AWS::GameLift::MatchmakingRuleSet
│    │ └ attributes
│    │    └ CreationTime: (documentation changed)
│    └[~] resource AWS::GameLift::Script
│      ├  - documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html
│      │  + documentation: The `AWS::GameLift::Script` resource creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session.
│      ├ properties
│      │  ├ StorageLocation: (documentation changed)
│      │  ├ Tags: (documentation changed)
│      │  └ Version: (documentation changed)
│      ├ attributes
│      │  ├ Arn: (documentation changed)
│      │  ├ CreationTime: (documentation changed)
│      │  └ Id: (documentation changed)
│      └ types
│         └[~] type S3Location
│           ├  - documentation: undefined
│           │  + documentation: The location in Amazon S3 where build or script files can be stored for access by Amazon GameLift.
│           └ properties
│              ├ Bucket: (documentation changed)
│              ├ Key: (documentation changed)
│              ├ ObjectVersion: (documentation changed)
│              └ RoleArn: (documentation changed)
├[~] service aws-grafana
│ └ resources
│    └[~] resource AWS::Grafana::Workspace
│      └ properties
│         └ PluginAdminEnabled: (documentation changed)
├[~] service aws-internetmonitor
│ └ resources
│    └[~] resource AWS::InternetMonitor::Monitor
│      └ types
│         ├[~] type InternetMeasurementsLogDelivery
│         │ └ properties
│         │    └ S3Config: (documentation changed)
│         └[~] type S3Config
│           ├  - documentation: The configuration for publishing Amazon CloudWatch Internet Monitor internet measurements to Amazon S3. The configuration includes the bucket name and (optionally) prefix for the S3 bucket to store the measurements, and the delivery status. The delivery status is `ENABLED` or `DISABLED` , depending on whether you choose to deliver internet measurements to S3 logs.
│           │  + documentation: The configuration for publishing Amazon CloudWatch Internet Monitor internet measurements to Amazon S3. The configuration includes the bucket name and (optionally) bucket prefix for the S3 bucket to store the measurements, and the delivery status. The delivery status is `ENABLED` if you choose to deliver internet measurements to S3 logs, and `DISABLED` otherwise.
│           │  The measurements are also published to Amazon CloudWatch Logs.
│           └ properties
│              ├ BucketName: (documentation changed)
│              ├ BucketPrefix: (documentation changed)
│              └ LogDeliveryStatus: (documentation changed)
├[~] service aws-iot
│ └ resources
│    └[~] resource AWS::IoT::SecurityProfile
│      └ types
│         └[~] type MetricsExportConfig
│           └ properties
│              ├ MqttTopic: (documentation changed)
│              └ RoleArn: (documentation changed)
├[~] service aws-networkmanager
│ └ resources
│    └[~] resource AWS::NetworkManager::Device
│      └ attributes
│         └ CreatedAt: (documentation changed)
├[~] service aws-pipes
│ └ resources
│    └[~] resource AWS::Pipes::Pipe
│      ├ properties
│      │  └ LogConfiguration: (documentation changed)
│      └ types
│         ├[~] type CloudwatchLogsLogDestination
│         │ ├  - documentation: undefined
│         │ │  + documentation: Represents the Amazon CloudWatch Logs logging configuration settings for the pipe.
│         │ └ properties
│         │    └ LogGroupArn: (documentation changed)
│         ├[~] type FirehoseLogDestination
│         │ ├  - documentation: undefined
│         │ │  + documentation: Represents the Amazon Kinesis Data Firehose logging configuration settings for the pipe.
│         │ └ properties
│         │    └ DeliveryStreamArn: (documentation changed)
│         ├[~] type PipeLogConfiguration
│         │ ├  - documentation: undefined
│         │ │  + documentation: Represents the configuration settings for the logs to which this pipe should report events.
│         │ └ properties
│         │    ├ CloudwatchLogsLogDestination: (documentation changed)
│         │    ├ FirehoseLogDestination: (documentation changed)
│         │    ├ IncludeExecutionData: (documentation changed)
│         │    ├ Level: (documentation changed)
│         │    └ S3LogDestination: (documentation changed)
│         └[~] type S3LogDestination
│           ├  - documentation: undefined
│           │  + documentation: Represents the Amazon S3 logging configuration settings for the pipe.
│           └ properties
│              ├ BucketName: (documentation changed)
│              ├ BucketOwner: (documentation changed)
│              ├ OutputFormat: (documentation changed)
│              └ Prefix: (documentation changed)
├[~] service aws-resiliencehub
│ └ resources
│    ├[~] resource AWS::ResilienceHub::App
│    │ ├  - documentation: Creates an AWS Resilience Hub application. An AWS Resilience Hub application is a collection of AWS resources structured to prevent and recover AWS application disruptions. To describe a AWS Resilience Hub application, you provide an application name, resources from one or more AWS CloudFormation stacks, AWS Resource Groups , Terraform state files, AppRegistry applications, and an appropriate resiliency policy. In addition, you can also add resources that are located on Amazon Elastic Kubernetes Service ( Amazon EKS ) clusters as optional resources. For more information about the number of resources supported per application, see [Service quotas](https://docs.aws.amazon.com/general/latest/gr/resiliencehub.html#limits_resiliencehub) .
│    │ │  After you create an AWS Resilience Hub application, you publish it so that you can run a resiliency assessment on it. You can then use recommendations from the assessment to improve resiliency by running another assessment, comparing results, and then iterating the process until you achieve your goals for recovery time objective (RTO) and recovery point objective (RPO).
│    │ │  + documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-app.html
│    │ ├ properties
│    │ │  ├ AppAssessmentSchedule: (documentation changed)
│    │ │  ├ Description: (documentation changed)
│    │ │  ├ EventSubscriptions: (documentation changed)
│    │ │  └ Name: (documentation changed)
│    │ └ types
│    │    ├[~] type EventSubscription
│    │    │ ├  - documentation: Indicates an event you would like to subscribe and get notification for. Currently, AWS Resilience Hub supports notifications only for *Drift detected* and *Scheduled assessment failure* events.
│    │    │ │  + documentation: Indicates an event you would like to subscribe and get notification for.
│    │    │ └ properties
│    │    │    ├ EventType: (documentation changed)
│    │    │    └ SnsTopicArn: (documentation changed)
│    │    ├[~] type PermissionModel
│    │    │ └ properties
│    │    │    ├ CrossAccountRoleArns: (documentation changed)
│    │    │    └ InvokerRoleName: (documentation changed)
│    │    ├[~] type PhysicalResourceId
│    │    │ ├  - documentation: Defines a physical resource identifier.
│    │    │ │  + documentation: undefined
│    │    │ └ properties
│    │    │    ├ AwsAccountId: (documentation changed)
│    │    │    ├ AwsRegion: (documentation changed)
│    │    │    ├ Identifier: (documentation changed)
│    │    │    └ Type: (documentation changed)
│    │    └[~] type ResourceMapping
│    │      ├  - documentation: Defines a resource mapping.
│    │      │  + documentation: Resource mapping is used to map logical resources from template to physical resource
│    │      └ properties
│    │         ├ LogicalStackName: (documentation changed)
│    │         ├ MappingType: (documentation changed)
│    │         ├ PhysicalResourceId: (documentation changed)
│    │         ├ ResourceName: (documentation changed)
│    │         └ TerraformSourceName: (documentation changed)
│    └[~] resource AWS::ResilienceHub::ResiliencyPolicy
│      ├  - documentation: Defines a resiliency policy.
│      │  > AWS Resilience Hub allows you to provide a value of zero for `rtoInSecs` and `rpoInSecs` of your resiliency policy. But, while assessing your application, the lowest possible assessment result is near zero. Hence, if you provide value zero for `rtoInSecs` and `rpoInSecs` , the estimated workload RTO and estimated workload RPO result will be near zero and the *Compliance status* for your application will be set to *Policy breached* .
│      │  + documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-resiliencehub-resiliencypolicy.html
│      ├ properties
│      │  ├ DataLocationConstraint: (documentation changed)
│      │  ├ Policy: (documentation changed)
│      │  ├ PolicyDescription: (documentation changed)
│      │  ├ PolicyName: (documentation changed)
│      │  └ Tier: (documentation changed)
│      └ types
│         └[~] type FailurePolicy
│           ├  - documentation: Defines a failure policy.
│           │  + documentation: Failure Policy.
│           └ properties
│              ├ RpoInSecs: (documentation changed)
│              └ RtoInSecs: (documentation changed)
├[~] service aws-rolesanywhere
│ └ resources
│    ├[~] resource AWS::RolesAnywhere::Profile
│    │ ├  - documentation: Creates a *profile* , a list of the roles that Roles Anywhere service is trusted to assume. You use profiles to intersect permissions with IAM managed policies.
│    │ │  *Required permissions:* `rolesanywhere:CreateProfile` .
│    │ │  + documentation: Creates a Profile.
│    │ └ properties
│    │    ├ DurationSeconds: (documentation changed)
│    │    ├ Enabled: (documentation changed)
│    │    ├ ManagedPolicyArns: (documentation changed)
│    │    ├ Name: (documentation changed)
│    │    ├ RequireInstanceProperties: (documentation changed)
│    │    ├ RoleArns: (documentation changed)
│    │    ├ SessionPolicy: (documentation changed)
│    │    └ Tags: (documentation changed)
│    └[~] resource AWS::RolesAnywhere::TrustAnchor
│      ├  - documentation: Creates a trust anchor to establish trust between IAM Roles Anywhere and your certificate authority (CA). You can define a trust anchor as a reference to an AWS Private Certificate Authority ( AWS Private CA ) or by uploading a CA certificate. Your AWS workloads can authenticate with the trust anchor using certificates issued by the CA in exchange for temporary AWS credentials.
│      │  *Required permissions:* `rolesanywhere:CreateTrustAnchor` .
│      │  + documentation: Creates a TrustAnchor.
│      └ types
│         ├[~] type Source
│         │ ├  - documentation: The trust anchor type and its related certificate data.
│         │ │  + documentation: Object representing the TrustAnchor type and its related certificate data.
│         │ └ properties
│         │    ├ SourceData: (documentation changed)
│         │    └ SourceType: (documentation changed)
│         └[~] type SourceData
│           └  - documentation: The data field of the trust anchor depending on its type.
│              + documentation: A union object representing the data field of the TrustAnchor depending on its type
└[~] service aws-s3
  └ resources
     ├[~] resource AWS::S3::StorageLens
     │ └ types
     │    ├[~] type AccountLevel
     │    │ └ properties
     │    │    └ StorageLensGroupLevel: (documentation changed)
     │    ├[~] type StorageLensGroupLevel
     │    │ ├  - documentation: Specifies the details of Amazon S3 Storage Lens Group configuration.
     │    │ │  + documentation: This resource determines the scope of Storage Lens group data that is displayed in the Storage Lens dashboard.
     │    │ └ properties
     │    │    └ StorageLensGroupSelectionCriteria: (documentation changed)
     │    └[~] type StorageLensGroupSelectionCriteria
     │      ├  - documentation: Selection criteria for Storage Lens Group level metrics
     │      │  + documentation: This resource indicates which Storage Lens group ARNs to include or exclude in the Storage Lens group aggregation. You can only attach Storage Lens groups to your dashboard if they're included in your Storage Lens group aggregation. If this value is left null, then all Storage Lens groups are selected.
     │      └ properties
     │         ├ Exclude: (documentation changed)
     │         └ Include: (documentation changed)
     └[~] resource AWS::S3::StorageLensGroup
       ├  - documentation: The AWS::S3::StorageLensGroup resource is an Amazon S3 resource type that you can use to create Storage Lens Group.
       │  + documentation: The `AWS::S3::StorageLensGroup` resource creates an S3 Storage Lens group. A Storage Lens group is a custom grouping of objects that include filters for prefixes, suffixes, object tags, object size, or object age. You can create an S3 Storage Lens group that includes a single filter or multiple filter conditions. To specify multiple filter conditions, you use `AND` or `OR` logical operators. For more information about S3 Storage Lens groups, see [Working with S3 Storage Lens groups](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-lens-groups-overview.html) .
       ├ properties
       │  ├ Filter: (documentation changed)
       │  ├ Name: (documentation changed)
       │  └ Tags: (documentation changed)
       └ types
          ├[~] type And
          │ ├  - documentation: The Storage Lens group will include objects that match all of the specified filter values.
          │ │  + documentation: This resource is a logical operator that allows multiple filter conditions to be joined for more complex comparisons of Storage Lens group data. Objects must match all of the listed filter conditions that are joined by the `And` logical operator. Only one of each filter condition is allowed.
          │ └ properties
          │    ├ MatchAnyPrefix: (documentation changed)
          │    ├ MatchAnySuffix: (documentation changed)
          │    ├ MatchAnyTag: (documentation changed)
          │    ├ MatchObjectAge: (documentation changed)
          │    └ MatchObjectSize: (documentation changed)
          ├[~] type Filter
          │ ├  - documentation: Sets the Storage Lens Group filter.
          │ │  + documentation: This resource sets the criteria for the Storage Lens group data that is displayed. For multiple filter conditions, the `AND` or `OR` logical operator is used.
          │ └ properties
          │    ├ And: (documentation changed)
          │    ├ MatchAnyPrefix: (documentation changed)
          │    ├ MatchAnySuffix: (documentation changed)
          │    ├ MatchAnyTag: (documentation changed)
          │    ├ MatchObjectAge: (documentation changed)
          │    ├ MatchObjectSize: (documentation changed)
          │    └ Or: (documentation changed)
          ├[~] type MatchObjectAge
          │ ├  - documentation: Filter to match all of the specified values for the minimum and maximum object age.
          │ │  + documentation: This resource contains `DaysGreaterThan` and `DaysLessThan` to define the object age range (minimum and maximum number of days).
          │ └ properties
          │    ├ DaysGreaterThan: (documentation changed)
          │    └ DaysLessThan: (documentation changed)
          ├[~] type MatchObjectSize
          │ ├  - documentation: Filter to match all of the specified values for the minimum and maximum object size.
          │ │  + documentation: This resource filters objects that match the specified object size range.
          │ └ properties
          │    ├ BytesGreaterThan: (documentation changed)
          │    └ BytesLessThan: (documentation changed)
          └[~] type Or
            ├  - documentation: The Storage Lens group will include objects that match any of the specified filter values.
            │  + documentation: This resource contains the `Or` logical operator, which allows multiple filter conditions to be joined for more complex comparisons of Storage Lens group data. Objects can match any of the listed filter conditions that are joined by the `Or` logical operator. Only one of each filter condition is allowed.
            └ properties
               ├ MatchAnyPrefix: (documentation changed)
               ├ MatchAnySuffix: (documentation changed)
               ├ MatchAnyTag: (documentation changed)
               ├ MatchObjectAge: (documentation changed)
               └ MatchObjectSize: (documentation changed)

@aws-cdk-automation aws-cdk-automation added this pull request to the merge queue Nov 17, 2023
Merged via the queue into main with commit 7fb4c6a Nov 17, 2023
11 checks passed
@aws-cdk-automation aws-cdk-automation deleted the update-source/documentation branch November 17, 2023 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