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

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

------

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

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

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

Copy link

github-actions bot commented Nov 1, 2024

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

├[~] service aws-appsync
│ └ resources
│    └[~] resource AWS::AppSync::Api
│      ├  - documentation: Resource schema for AppSync Api
│      │  + documentation: Creates a `GraphqlApi` object.
│      ├ properties
│      │  ├ Name: (documentation changed)
│      │  ├ OwnerContact: (documentation changed)
│      │  └ Tags: (documentation changed)
│      ├ attributes
│      │  └ ApiId: (documentation changed)
│      └ types
│         ├[~] type LambdaAuthorizerConfig
│         │ ├  - documentation: A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode. Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time.
│         │ │  + documentation: A `LambdaAuthorizerConfig` specifies how to authorize AWS AppSync API access when using the `AWS_LAMBDA` authorizer mode. Be aware that an AWS AppSync API can have only one AWS Lambda authorizer configured at a time.
│         │ └ properties
│         │    ├ AuthorizerResultTtlInSeconds: (documentation changed)
│         │    ├ AuthorizerUri: (documentation changed)
│         │    └ IdentityValidationExpression: (documentation changed)
│         └[~] type OpenIDConnectConfig
│           ├  - documentation: The OpenID Connect configuration.
│           │  + documentation: Describes an OpenID Connect (OIDC) configuration.
│           └ properties
│              ├ AuthTTL: (documentation changed)
│              ├ ClientId: (documentation changed)
│              ├ IatTTL: (documentation changed)
│              └ Issuer: (documentation changed)
├[~] service aws-codepipeline
│ └ resources
│    └[~] resource AWS::CodePipeline::Pipeline
│      └ types
│         ├[~] type FailureConditions
│         │ └ properties
│         │    └ RetryConfiguration: (documentation changed)
│         └[~] type RetryConfiguration
│           ├  - documentation: The configuration that specifies the retry configuration for a stage
│           │  + documentation: The retry configuration specifies automatic retry for a failed stage, along with the configured retry mode.
│           └ properties
│              └ RetryMode: (documentation changed)
├[~] service aws-connect
│ └ resources
│    └[~] resource AWS::Connect::User
│      └ types
│         └[~] type UserIdentityInfo
│           └  - documentation: Contains information about the identity of a user.
│              > For Amazon Connect instances that are created with the `EXISTING_DIRECTORY` identity management type, `FirstName` , `LastName` , and `Email` cannot be updated from within Amazon Connect because they are managed by the directory.
│              + documentation: Contains information about the identity of a user.
│              > For Amazon Connect instances that are created with the `EXISTING_DIRECTORY` identity management type, `FirstName` , `LastName` , and `Email` cannot be updated from within Amazon Connect because they are managed by the directory. > The `FirstName` and `LastName` length constraints below apply only to instances using SAML for identity management. If you are using Amazon Connect for identity management, the length constraints are 1-255 for `FirstName` , and 1-256 for `LastName` .
├[~] service aws-datasync
│ └ resources
│    └[~] resource AWS::DataSync::Task
│      └ properties
│         ├ CloudWatchLogGroupArn: (documentation changed)
│         └ Includes: (documentation changed)
├[~] service aws-ecs
│ └ resources
│    ├[~] resource AWS::ECS::CapacityProvider
│    │ └ types
│    │    └[~] type ManagedScaling
│    │      └ properties
│    │         └ MinimumScalingStepSize: (documentation changed)
│    ├[~] resource AWS::ECS::Service
│    │ ├ properties
│    │ │  └ DeploymentConfiguration: (documentation changed)
│    │ └ types
│    │    ├[~] type DeploymentConfiguration
│    │    │ └  - documentation: Optional deployment parameters that control how many tasks run during a deployment and the ordering of stopping and starting tasks.
│    │    │    + documentation: Optional deployment parameters that control how many tasks run during the deployment and the failure detection methods.
│    │    └[~] type LoadBalancer
│    │      └ properties
│    │         └ LoadBalancerName: (documentation changed)
│    └[~] resource AWS::ECS::TaskDefinition
│      ├ properties
│      │  ├ IpcMode: (documentation changed)
│      │  ├ NetworkMode: (documentation changed)
│      │  └ PidMode: (documentation changed)
│      └ types
│         ├[~] type PortMapping
│         │ └ properties
│         │    └ ContainerPort: (documentation changed)
│         └[~] type RuntimePlatform
│           └ properties
│              ├ CpuArchitecture: (documentation changed)
│              └ OperatingSystemFamily: (documentation changed)
├[~] service aws-mediapackagev2
│ └ resources
│    └[~] resource AWS::MediaPackageV2::OriginEndpoint
│      └ types
│         ├[~] type FilterConfiguration
│         │ └ properties
│         │    └ ClipStartTime: (documentation changed)
│         └[~] type StartTag
│           ├  - documentation: <p>To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag.</p>
│           │  + documentation: To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag.
│           └ properties
│              ├ Precise: (documentation changed)
│              └ TimeOffset: (documentation changed)
├[~] service aws-networkfirewall
│ └ resources
│    └[~] resource AWS::NetworkFirewall::FirewallPolicy
│      └ types
│         ├[~] type FlowTimeouts
│         │ ├  - documentation: undefined
│         │ │  + documentation: Describes the amount of time that can pass without any traffic sent through the firewall before the firewall determines that the connection is idle and Network Firewall removes the flow entry from its flow table. Existing connections and flows are not impacted when you update this value. Only new connections after you update this value are impacted.
│         │ └ properties
│         │    └ TcpIdleTimeoutSeconds: (documentation changed)
│         └[~] type StatefulEngineOptions
│           └ properties
│              └ FlowTimeouts: (documentation changed)
├[~] service aws-opensearchservice
│ └ resources
│    ├[~] resource AWS::OpenSearchService::Application
│    │ ├  - documentation: Amazon OpenSearchService application resource
│    │ │  + documentation: Creates an OpenSearch Application.
│    │ ├ properties
│    │ │  ├ Endpoint: (documentation changed)
│    │ │  ├ IamIdentityCenterOptions: (documentation changed)
│    │ │  └ Name: (documentation changed)
│    │ ├ attributes
│    │ │  ├ Arn: (documentation changed)
│    │ │  └ Id: (documentation changed)
│    │ └ types
│    │    ├[~] type AppConfig
│    │    │ ├  - documentation: A key-value pair of AppConfig
│    │    │ │  + documentation: Configurations of the OpenSearch Application.
│    │    │ └ properties
│    │    │    ├ Key: (documentation changed)
│    │    │    └ Value: (documentation changed)
│    │    ├[~] type DataSource
│    │    │ ├  - documentation: Datasource arn and description
│    │    │ │  + documentation: Data sources that are associated with an OpenSearch Application.
│    │    │ └ properties
│    │    │    └ DataSourceDescription: (documentation changed)
│    │    └[~] type IamIdentityCenterOptions
│    │      ├  - documentation: Options for configuring IAM Identity Center
│    │      │  + documentation: Settings for IAM Identity Center for an OpenSearch Application.
│    │      └ properties
│    │         ├ Enabled: (documentation changed)
│    │         └ IamRoleForIdentityCenterApplicationArn: (documentation changed)
│    └[~] resource AWS::OpenSearchService::Domain
│      ├ properties
│      │  └ IdentityCenterOptions: (documentation changed)
│      ├ attributes
│      │  ├ IdentityCenterOptions.IdentityCenterApplicationARN: (documentation changed)
│      │  └ IdentityCenterOptions.IdentityStoreId: (documentation changed)
│      └ types
│         └[~] type IdentityCenterOptions
│           ├  - documentation: Options for configuring Identity Center
│           │  + documentation: Container for IAM Identity Center Options settings.
│           └ properties
│              ├ EnabledAPIAccess: (documentation changed)
│              ├ IdentityCenterApplicationARN: (documentation changed)
│              ├ IdentityCenterInstanceARN: (documentation changed)
│              ├ IdentityStoreId: (documentation changed)
│              ├ RolesKey: (documentation changed)
│              └ SubjectKey: (documentation changed)
└[~] service aws-route53
  └ resources
     ├[~] resource AWS::Route53::RecordSet
     │ └ properties
     │    └ Type: (documentation changed)
     └[~] resource AWS::Route53::RecordSetGroup
       └ types
          └[~] type RecordSet
            └ properties
               └ Type: (documentation changed)

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