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

Merged
merged 1 commit into from
Nov 21, 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/6938801572

------

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

Copy link

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

├[~] service aws-apigatewayv2
│ └ resources
│    ├[~] resource AWS::ApiGatewayV2::ApiGatewayManagedOverrides
│    │ └ attributes
│    │    └ Id: (documentation changed)
│    ├[~] resource AWS::ApiGatewayV2::ApiMapping
│    │ └ properties
│    │    └ ApiId: (documentation changed)
│    ├[~] resource AWS::ApiGatewayV2::Integration
│    │ ├ attributes
│    │ │  └ Id: (documentation changed)
│    │ └ types
│    │    ├[~] type ResponseParameter
│    │    │ ├  - documentation: Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match the pattern `<action>:<header>.<location>` or `overwrite.statuscode` . The action can be `append` , `overwrite` or `remove` . The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see [Transforming API requests and responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html) .
│    │    │ │  + documentation: undefined
│    │    │ └ properties
│    │    │    ├ Destination: (documentation changed)
│    │    │    └ Source: (documentation changed)
│    │    └[~] type ResponseParameterList
│    │      ├  - documentation: Specifies a list of response parameters for an HTTP API.
│    │      │  + documentation: undefined
│    │      └ properties
│    │         └ ResponseParameters: (documentation changed)
│    └[~] resource AWS::ApiGatewayV2::Stage
│      └ attributes
│         └ Id: (documentation changed)
├[~] service aws-cloud9
│ └ resources
│    └[~] resource AWS::Cloud9::EnvironmentEC2
│      └ properties
│         └ ImageId: (documentation changed)
├[~] service aws-cloudtrail
│ └ resources
│    └[~] resource AWS::CloudTrail::EventDataStore
│      └ properties
│         ├ BillingMode: (documentation changed)
│         └ RetentionPeriod: (documentation changed)
├[~] service aws-codepipeline
│ └ resources
│    └[~] resource AWS::CodePipeline::Pipeline
│      └  - documentation: The `AWS::CodePipeline::Pipeline` resource creates a CodePipeline pipeline that describes how software changes go through a release process. For more information, see [What Is CodePipeline?](https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html) in the *AWS CodePipeline User Guide* .
│         > V2 type pipelines, along with triggers on Git tags and pipeline-level variables, are not currently supported for CloudFormation and CDK resources in CodePipeline. For more information about V2 type pipelines, see [Pipeline types](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-types.html) in the *AWS CodePipeline User Guide* .
│         + documentation: The `AWS::CodePipeline::Pipeline` resource creates a CodePipeline pipeline that describes how software changes go through a release process. For more information, see [What Is CodePipeline?](https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html) in the *AWS CodePipeline User Guide* .
├[~] service aws-dlm
│ └ resources
│    └[~] resource AWS::DLM::LifecyclePolicy
│      └ types
│         └[~] type Script
│           └ properties
│              ├ ExecutionHandler: (documentation changed)
│              └ ExecutionHandlerService: (documentation changed)
├[~] service aws-ec2
│ └ resources
│    └[~] resource AWS::EC2::IPAM
│      └ properties
│         └ Tier: (documentation changed)
├[~] service aws-events
│ └ resources
│    └[~] resource AWS::Events::Rule
│      └ properties
│         └ State: (documentation changed)
├[~] service aws-guardduty
│ └ resources
│    └[~] resource AWS::GuardDuty::Detector
│      └ types
│         └[~] type TagItem
│           ├  - documentation: undefined
│           │  + documentation: Describes a tag.
│           └ properties
│              ├ Key: (documentation changed)
│              └ Value: (documentation changed)
├[~] service aws-imagebuilder
│ └ resources
│    └[~] resource AWS::ImageBuilder::LifecyclePolicy
│      ├  - documentation: Resource schema for AWS::ImageBuilder::LifecyclePolicy
│      │  + documentation: The configuration details for a lifecycle policy resource.
│      ├ properties
│      │  ├ Description: (documentation changed)
│      │  ├ ExecutionRole: (documentation changed)
│      │  ├ PolicyDetails: (documentation changed)
│      │  ├ ResourceSelection: (documentation changed)
│      │  ├ ResourceType: (documentation changed)
│      │  ├ Status: (documentation changed)
│      │  └ Tags: (documentation changed)
│      ├ attributes
│      │  └ Arn: (documentation changed)
│      └ types
│         └[~] type Filter
│           └  - documentation: The filters to apply of the policy detail.
│              + documentation: A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
├[~] service aws-iot
│ └ resources
│    └[~] resource AWS::IoT::SecurityProfile
│      ├ properties
│      │  └ MetricsExportConfig: (documentation changed)
│      └ types
│         ├[~] type Behavior
│         │ └ properties
│         │    └ ExportMetric: (documentation changed)
│         ├[~] type MetricsExportConfig
│         │ └  - documentation: A structure containing the mqtt topic for metrics export.
│         │    + documentation: Specifies the MQTT topic and role ARN required for metric export.
│         └[~] type MetricToRetain
│           └ properties
│              └ ExportMetric: (documentation changed)
├[~] service aws-iot1click
│ └ resources
│    └[~] resource AWS::IoT1Click::Project
│      └ types
│         └[~] type DeviceTemplate
│           ├  - documentation: In AWS CloudFormation , use the `DeviceTemplate` property type to define the template for an AWS IoT 1-Click project.
│           │  `DeviceTemplate` is a property of the `AWS::IoT1Click::Project` resource.
│           │  + documentation: undefined
│           └ properties
│              ├ CallbackOverrides: (documentation changed)
│              └ DeviceType: (documentation changed)
├[~] service aws-mwaa
│ └ resources
│    └[~] resource AWS::MWAA::Environment
│      ├ properties
│      │  └ EndpointManagement: (documentation changed)
│      └ attributes
│         ├ CeleryExecutorQueue: (documentation changed)
│         ├ DatabaseVpcEndpointService: (documentation changed)
│         └ WebserverVpcEndpointService: (documentation changed)
├[~] service aws-networkmanager
│ └ resources
│    └[~] resource AWS::NetworkManager::Device
│      └ attributes
│         └ CreatedAt: (documentation changed)
├[~] service aws-opensearchserverless
│ └ resources
│    └[~] resource AWS::OpenSearchServerless::LifecyclePolicy
│      ├  - documentation: Amazon OpenSearchServerless lifecycle policy resource
│      │  + documentation: Creates a lifecyle policy to be applied to OpenSearch Serverless indexes. Lifecycle policies define the number of days or hours to retain the data on an OpenSearch Serverless index. For more information, see [Creating data lifecycle policies](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-create) .
│      └ properties
│         ├ Description: (documentation changed)
│         ├ Name: (documentation changed)
│         ├ Policy: (documentation changed)
│         └ Type: (documentation changed)
└[~] service aws-transfer
  └ resources
     ├[~] resource AWS::Transfer::Server
     │ └ types
     │    └[~] type ProtocolDetails
     │      └  - documentation: The protocol settings that are configured for your server.
     │         + documentation: The protocol settings that are configured for your server.
     │         - To indicate passive mode (for FTP and FTPS protocols), use the `PassiveIp` parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
     │         - To ignore the error that is generated when the client attempts to use the `SETSTAT` command on a file that you are uploading to an Amazon S3 bucket, use the `SetStatOption` parameter. To have the AWS Transfer Family server ignore the `SETSTAT` command and upload files without needing to make any changes to your SFTP client, set the value to `ENABLE_NO_OP` . If you set the `SetStatOption` parameter to `ENABLE_NO_OP` , Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a `SETSTAT` call.
     │         - To determine whether your AWS Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the `TlsSessionResumptionMode` parameter.
     │         - `As2Transports` indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
     └[~] resource AWS::Transfer::User
       └ types
          └[~] type HomeDirectoryMapEntry
            └ properties
               └ Target: (documentation changed)

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