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

Merged
merged 1 commit into from
Oct 26, 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/6649025267

------

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

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

@github-actions
Copy link

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

├[~] service aws-appconfig
│ └ resources
│    └[~] resource AWS::AppConfig::Application
│      └ attributes
│         └ ApplicationId: (documentation changed)
├[~] service aws-appstream
│ └ resources
│    ├[~] resource AWS::AppStream::AppBlock
│    │ └ properties
│    │    └ PostSetupScriptDetails: (documentation changed)
│    └[~] resource AWS::AppStream::AppBlockBuilder
│      ├ properties
│      │  └ Platform: (documentation changed)
│      └ attributes
│         ├ Arn: (documentation changed)
│         └ CreatedTime: (documentation changed)
├[~] service aws-customerprofiles
│ └ resources
│    └[~] resource AWS::CustomerProfiles::Domain
│      ├ properties
│      │  ├ DeadLetterQueueUrl: (documentation changed)
│      │  ├ Matching: (documentation changed)
│      │  └ RuleBasedMatching: (documentation changed)
│      ├ attributes
│      │  └ RuleBasedMatching.Status: (documentation changed)
│      └ types
│         ├[~] type AttributeTypesSelector
│         │ ├  - documentation: Configures information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles.
│         │ │  + documentation: Configures information about the `AttributeTypesSelector` which rule-based identity resolution uses to match profiles.
│         │ └ properties
│         │    ├ Address: (documentation changed)
│         │    ├ AttributeMatchingModel: (documentation changed)
│         │    ├ EmailAddress: (documentation changed)
│         │    └ PhoneNumber: (documentation changed)
│         ├[~] type AutoMerging
│         │ └ properties
│         │    ├ ConflictResolution: (documentation changed)
│         │    └ MinAllowedConfidenceScoreForMerging: (documentation changed)
│         ├[~] type ConflictResolution
│         │ ├  - documentation: How the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same FirstName and LastName (and that is the matching criteria), which EmailAddress should be used? 
│         │ │  + documentation: Determines how the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same `FirstName` and `LastName` , `ConflictResolution` specifies which `EmailAddress` should be used.
│         │ └ properties
│         │    └ SourceName: (documentation changed)
│         ├[~] type Matching
│         │ ├  - documentation: The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.
│         │ │  + documentation: The process of matching duplicate profiles. If `Matching = true` , Amazon Connect Customer Profiles starts a weekly batch process called *Identity Resolution Job* . If you do not specify a date and time for the *Identity Resolution Job* to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the *Identity Resolution Job* completes, use the `GetMatches` API to return and review the results. Or, if you have configured `ExportingConfig` in the `MatchingRequest` , you can download the results from S3.
│         │ └ properties
│         │    └ ExportingConfig: (documentation changed)
│         ├[~] type MatchingRule
│         │ ├  - documentation: Specifies how does the rule-based matching process should match profiles.
│         │ │  + documentation: Specifies how the rule-based matching process should match profiles.
│         │ └ properties
│         │    └ Rule: (documentation changed)
│         └[~] type RuleBasedMatching
│           ├  - documentation: The process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.
│           │  + documentation: The process of matching duplicate profiles using Rule-Based matching. If `RuleBasedMatching = true` , Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the `RuleBasedMatchingRequest` . You can use the `ListRuleBasedMatches` and `GetSimilarProfiles` API to return and review the results. Also, if you have configured `ExportingConfig` in the `RuleBasedMatchingRequest` , you can download the results from S3.
│           └ properties
│              ├ AttributeTypesSelector: (documentation changed)
│              ├ ConflictResolution: (documentation changed)
│              ├ Enabled: (documentation changed)
│              ├ ExportingConfig: (documentation changed)
│              ├ MatchingRules: (documentation changed)
│              └ Status: (documentation changed)
├[~] service aws-ec2
│ └ resources
│    ├[~] resource AWS::EC2::Instance
│    │ └ types
│    │    └[~] type HibernationOptions
│    │      └ properties
│    │         └ Configured: (documentation changed)
│    ├[~] resource AWS::EC2::LaunchTemplate
│    │ └ types
│    │    ├[~] type BlockDeviceMapping
│    │    │ └  - documentation: Information about a block device mapping for an Amazon EC2 launch template.
│    │    │    `BlockDeviceMapping` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) .
│    │    │    + documentation: Specifies a block device mapping for a launch template. You must specify `DeviceName` plus exactly one of the following properties: `Ebs` , `NoDevice` , or `VirtualName` .
│    │    │    `BlockDeviceMapping` is a property of [AWS::EC2::LaunchTemplate LaunchTemplateData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html) .
│    │    └[~] type TagSpecification
│    │      └ properties
│    │         └ ResourceType: (documentation changed)
│    ├[~] resource AWS::EC2::VerifiedAccessInstance
│    │ ├ properties
│    │ │  ├ FipsEnabled: (documentation changed)
│    │ │  └ LoggingConfigurations: (documentation changed)
│    │ └ types
│    │    └[~] type VerifiedAccessLogs
│    │      └ properties
│    │         ├ IncludeTrustContext: (documentation changed)
│    │         └ LogVersion: (documentation changed)
│    └[~] resource AWS::EC2::VPCEndpoint
│      └ properties
│         └ VpcEndpointType: (documentation changed)
├[~] service aws-eks
│ └ resources
│    └[~] resource AWS::EKS::Cluster
│      ├  - documentation: Creates an Amazon EKS control plane.
│      │  The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as `etcd` and the API server. The control plane runs in an account managed by AWS , and the Kubernetes API is exposed by the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single tenant and unique. It runs on its own set of Amazon EC2 instances.
│      │  The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide connectivity from the control plane instances to the nodes (for example, to support `kubectl exec` , `logs` , and `proxy` data flows).
│      │  Amazon EKS nodes run in your AWS account and connect to your cluster's control plane over the Kubernetes API server endpoint and a certificate file that is created for your cluster.
│      │  In most cases, it takes several minutes to create a cluster. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch nodes into your cluster. For more information, see [Managing Cluster Authentication](https://docs.aws.amazon.com/eks/latest/userguide/managing-auth.html) and [Launching Amazon EKS nodes](https://docs.aws.amazon.com/eks/latest/userguide/launch-workers.html) in the *Amazon EKS User Guide* .
│      │  + documentation: Creates an Amazon EKS control plane.
│      │  The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as `etcd` and the API server. The control plane runs in an account managed by AWS , and the Kubernetes API is exposed by the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single tenant and unique. It runs on its own set of Amazon EC2 instances.
│      │  The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide connectivity from the control plane instances to the nodes (for example, to support `kubectl exec` , `logs` , and `proxy` data flows).
│      │  Amazon EKS nodes run in your AWS account and connect to your cluster's control plane over the Kubernetes API server endpoint and a certificate file that is created for your cluster.
│      │  You can use the `endpointPublicAccess` and `endpointPrivateAccess` parameters to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see [Amazon EKS Cluster Endpoint Access Control](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) in the **Amazon EKS User Guide** .
│      │  You can use the `logging` parameter to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see [Amazon EKS Cluster Control Plane Logs](https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html) in the **Amazon EKS User Guide** .
│      │  > CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see [CloudWatch Pricing](https://docs.aws.amazon.com/cloudwatch/pricing/) . 
│      │  In most cases, it takes several minutes to create a cluster. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch nodes into your cluster. For more information, see [Managing Cluster Authentication](https://docs.aws.amazon.com/eks/latest/userguide/managing-auth.html) and [Launching Amazon EKS nodes](https://docs.aws.amazon.com/eks/latest/userguide/launch-workers.html) in the *Amazon EKS User Guide* .
│      └ properties
│         └ ResourcesVpcConfig: (documentation changed)
├[~] service aws-gamelift
│ └ resources
│    └[~] resource AWS::GameLift::Build
│      └ properties
│         └ ServerSdkVersion: (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) 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.
│           │  + 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.
│           └ properties
│              ├ BucketName: (documentation changed)
│              ├ BucketPrefix: (documentation changed)
│              └ LogDeliveryStatus: (documentation changed)
├[~] service aws-ivs
│ └ resources
│    ├[~] resource AWS::IVS::Channel
│    │ └ properties
│    │    └ Tags: (documentation changed)
│    ├[~] resource AWS::IVS::PlaybackKeyPair
│    │ └ properties
│    │    └ Tags: (documentation changed)
│    ├[~] resource AWS::IVS::RecordingConfiguration
│    │ └ properties
│    │    └ Tags: (documentation changed)
│    └[~] resource AWS::IVS::StreamKey
│      └ properties
│         └ Tags: (documentation changed)
├[~] service aws-ivschat
│ └ resources
│    ├[~] resource AWS::IVSChat::LoggingConfiguration
│    │ └ properties
│    │    └ Tags: (documentation changed)
│    └[~] resource AWS::IVSChat::Room
│      └ properties
│         └ Tags: (documentation changed)
└[~] service aws-networkmanager
  └ resources
     └[~] resource AWS::NetworkManager::ConnectPeer
       └ properties
          └ SubnetArn: (documentation changed)

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