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

Merged
merged 1 commit into from
Sep 17, 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/10895938454

------

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

Copy link

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

├[~] service aws-athena
│ └ resources
│    └[~] resource AWS::Athena::WorkGroup
│      └ types
│         ├[~] type ResultConfiguration
│         │ └ properties
│         │    ├ EncryptionConfiguration: (documentation changed)
│         │    └ OutputLocation: (documentation changed)
│         ├[~] type ResultConfigurationUpdates
│         │ └ properties
│         │    ├ RemoveEncryptionConfiguration: (documentation changed)
│         │    └ RemoveOutputLocation: (documentation changed)
│         └[~] type WorkGroupConfiguration
│           └ properties
│              ├ EnforceWorkGroupConfiguration: (documentation changed)
│              └ ResultConfiguration: (documentation changed)
├[~] service aws-connect
│ └ resources
│    ├[~] resource AWS::Connect::AgentStatus
│    │ ├  - documentation: Resource Type definition for AWS::Connect::AgentStatus
│    │ │  + documentation: Contains information about an agent status.
│    │ ├ properties
│    │ │  ├ Description: (documentation changed)
│    │ │  ├ DisplayOrder: (documentation changed)
│    │ │  ├ InstanceArn: (documentation changed)
│    │ │  ├ Name: (documentation changed)
│    │ │  ├ State: (documentation changed)
│    │ │  └ Tags: (documentation changed)
│    │ └ attributes
│    │    ├ LastModifiedRegion: (documentation changed)
│    │    └ LastModifiedTime: (documentation changed)
│    └[~] resource AWS::Connect::UserHierarchyStructure
│      ├  - documentation: Resource Type definition for AWS::Connect::UserHierarchyStructure
│      │  + documentation: Contains information about a hierarchy structure.
│      ├ properties
│      │  ├ InstanceArn: (documentation changed)
│      │  └ UserHierarchyStructure: (documentation changed)
│      ├ attributes
│      │  └ UserHierarchyStructureArn: (documentation changed)
│      └ types
│         ├[~] type LevelFive
│         │ └  - documentation: Information about level five.
│         │    + documentation: The update for level five.
│         ├[~] type LevelFour
│         │ └  - documentation: Information about level four.
│         │    + documentation: The update for level four.
│         ├[~] type LevelThree
│         │ └  - documentation: Information about level three.
│         │    + documentation: The update for level three.
│         ├[~] type LevelTwo
│         │ └  - documentation: Information about level two.
│         │    + documentation: The update for level two.
│         └[~] type UserHierarchyStructure
│           ├  - documentation: Information about the hierarchy structure.
│           │  + documentation: Contains information about a hierarchy structure.
│           └ properties
│              ├ LevelFour: (documentation changed)
│              ├ LevelOne: (documentation changed)
│              ├ LevelThree: (documentation changed)
│              └ LevelTwo: (documentation changed)
├[~] service aws-datazone
│ └ resources
│    └[~] resource AWS::DataZone::Environment
│      └ properties
│         ├ EnvironmentAccountIdentifier: (documentation changed)
│         ├ EnvironmentAccountRegion: (documentation changed)
│         └ EnvironmentRoleArn: (documentation changed)
└[~] service aws-msk
  └ resources
     ├[~] resource AWS::MSK::Cluster
     │ ├  - documentation: Creates a new MSK cluster. The following Python 3.6 examples shows how you can create a cluster that's distributed over two Availability Zones. Before you run this Python script, replace the example subnet and security-group IDs with the IDs of your subnets and security group. When you create an MSK cluster, its brokers get evenly distributed over a number of Availability Zones that's equal to the number of subnets that you specify in the `BrokerNodeGroupInfo` parameter. In this example, you can add a third subnet to get a cluster that's distributed over three Availability Zones.
     │ │  ```PYTHON
     │ │  import boto3 client = boto3.client('kafka') response = client.create_cluster( BrokerNodeGroupInfo={ 'BrokerAZDistribution': 'DEFAULT', 'ClientSubnets': [ 'subnet-012345678901fedcba', 'subnet-9876543210abcdef01' ], 'InstanceType': 'kafka.m5.large', 'SecurityGroups': [ 'sg-012345abcdef789789' ] }, ClusterName='SalesCluster', EncryptionInfo={ 'EncryptionInTransit': { 'ClientBroker': 'TLS_PLAINTEXT', 'InCluster': True } }, EnhancedMonitoring='PER_TOPIC_PER_BROKER', KafkaVersion='2.2.1', NumberOfBrokerNodes=2
     │ │  ) print(response)
     │ │  ```
     │ │  + documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html
     │ ├ properties
     │ │  ├ BrokerNodeGroupInfo: (documentation changed)
     │ │  ├ ClientAuthentication: (documentation changed)
     │ │  ├ ClusterName: (documentation changed)
     │ │  ├ ConfigurationInfo: (documentation changed)
     │ │  ├ CurrentVersion: (documentation changed)
     │ │  ├ EncryptionInfo: (documentation changed)
     │ │  ├ EnhancedMonitoring: (documentation changed)
     │ │  ├ KafkaVersion: (documentation changed)
     │ │  ├ LoggingInfo: (documentation changed)
     │ │  ├ NumberOfBrokerNodes: (documentation changed)
     │ │  ├ OpenMonitoring: (documentation changed)
     │ │  ├ StorageMode: (documentation changed)
     │ │  └ Tags: (documentation changed)
     │ └ types
     │    ├[~] type BrokerLogs
     │    │ ├  - documentation: The broker logs configuration for this MSK cluster.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    ├ CloudWatchLogs: (documentation changed)
     │    │    ├ Firehose: (documentation changed)
     │    │    └ S3: (documentation changed)
     │    ├[~] type BrokerNodeGroupInfo
     │    │ ├  - documentation: Describes the setup to be used for the broker nodes in the cluster.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    ├ BrokerAZDistribution: (documentation changed)
     │    │    ├ ClientSubnets: (documentation changed)
     │    │    ├ ConnectivityInfo: (documentation changed)
     │    │    ├ SecurityGroups: (documentation changed)
     │    │    └ StorageInfo: (documentation changed)
     │    ├[~] type ClientAuthentication
     │    │ ├  - documentation: Includes all client authentication information.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    ├ Sasl: (documentation changed)
     │    │    ├ Tls: (documentation changed)
     │    │    └ Unauthenticated: (documentation changed)
     │    ├[~] type CloudWatchLogs
     │    │ ├  - documentation: Details of the CloudWatch Logs destination for broker logs.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    ├ Enabled: (documentation changed)
     │    │    └ LogGroup: (documentation changed)
     │    ├[~] type ConfigurationInfo
     │    │ ├  - documentation: Specifies the configuration to use for the brokers.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    ├ Arn: (documentation changed)
     │    │    └ Revision: (documentation changed)
     │    ├[~] type ConnectivityInfo
     │    │ ├  - documentation: Broker access controls.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    ├ PublicAccess: (documentation changed)
     │    │    └ VpcConnectivity: (documentation changed)
     │    ├[~] type EBSStorageInfo
     │    │ ├  - documentation: Contains information about the EBS storage volumes attached to the broker nodes.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    ├ ProvisionedThroughput: (documentation changed)
     │    │    └ VolumeSize: (documentation changed)
     │    ├[~] type EncryptionAtRest
     │    │ ├  - documentation: The data-volume encryption details. You can't update encryption at rest settings for existing clusters.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    └ DataVolumeKMSKeyId: (documentation changed)
     │    ├[~] type EncryptionInfo
     │    │ ├  - documentation: Includes encryption-related information, such as the Amazon KMS key used for encrypting data at rest and whether you want MSK to encrypt your data in transit.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    ├ EncryptionAtRest: (documentation changed)
     │    │    └ EncryptionInTransit: (documentation changed)
     │    ├[~] type EncryptionInTransit
     │    │ ├  - documentation: The settings for encrypting data in transit.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    ├ ClientBroker: (documentation changed)
     │    │    └ InCluster: (documentation changed)
     │    ├[~] type Firehose
     │    │ ├  - documentation: Firehose details for BrokerLogs.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    ├ DeliveryStream: (documentation changed)
     │    │    └ Enabled: (documentation changed)
     │    ├[~] type Iam
     │    │ ├  - documentation: Details for SASL/IAM client authentication.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    └ Enabled: (documentation changed)
     │    ├[~] type JmxExporter
     │    │ ├  - documentation: Indicates whether you want to enable or disable the JMX Exporter.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    └ EnabledInBroker: (documentation changed)
     │    ├[~] type LoggingInfo
     │    │ ├  - documentation: You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    └ BrokerLogs: (documentation changed)
     │    ├[~] type NodeExporter
     │    │ ├  - documentation: Indicates whether you want to enable or disable the Node Exporter.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    └ EnabledInBroker: (documentation changed)
     │    ├[~] type OpenMonitoring
     │    │ ├  - documentation: JMX and Node monitoring for the MSK cluster.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    └ Prometheus: (documentation changed)
     │    ├[~] type Prometheus
     │    │ ├  - documentation: Prometheus settings for open monitoring.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    ├ JmxExporter: (documentation changed)
     │    │    └ NodeExporter: (documentation changed)
     │    ├[~] type ProvisionedThroughput
     │    │ ├  - documentation: Contains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    ├ Enabled: (documentation changed)
     │    │    └ VolumeThroughput: (documentation changed)
     │    ├[~] type PublicAccess
     │    │ ├  - documentation: Broker access controls
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    └ Type: (documentation changed)
     │    ├[~] type S3
     │    │ ├  - documentation: The details of the Amazon S3 destination for broker logs.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    ├ Bucket: (documentation changed)
     │    │    ├ Enabled: (documentation changed)
     │    │    └ Prefix: (documentation changed)
     │    ├[~] type Sasl
     │    │ ├  - documentation: Details for client authentication using SASL. To turn on SASL, you must also turn on `EncryptionInTransit` by setting `inCluster` to true. You must set `clientBroker` to either `TLS` or `TLS_PLAINTEXT` . If you choose `TLS_PLAINTEXT` , then you must also set `unauthenticated` to true.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    ├ Iam: (documentation changed)
     │    │    └ Scram: (documentation changed)
     │    ├[~] type Scram
     │    │ ├  - documentation: Details for SASL/SCRAM client authentication.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    └ Enabled: (documentation changed)
     │    ├[~] type StorageInfo
     │    │ ├  - documentation: Contains information about storage volumes attached to Amazon MSK broker nodes.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    └ EBSStorageInfo: (documentation changed)
     │    ├[~] type Tls
     │    │ ├  - documentation: Details for client authentication using TLS.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    ├ CertificateAuthorityArnList: (documentation changed)
     │    │    └ Enabled: (documentation changed)
     │    ├[~] type Unauthenticated
     │    │ ├  - documentation: Details for allowing no client authentication.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    └ Enabled: (documentation changed)
     │    ├[~] type VpcConnectivity
     │    │ ├  - documentation: VPC connection control settings for brokers.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    └ ClientAuthentication: (documentation changed)
     │    ├[~] type VpcConnectivityClientAuthentication
     │    │ ├  - documentation: Includes all client authentication information for VpcConnectivity.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    ├ Sasl: (documentation changed)
     │    │    └ Tls: (documentation changed)
     │    ├[~] type VpcConnectivityIam
     │    │ ├  - documentation: Details for SASL/IAM client authentication for VpcConnectivity.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    └ Enabled: (documentation changed)
     │    ├[~] type VpcConnectivitySasl
     │    │ ├  - documentation: Details for client authentication using SASL for VpcConnectivity.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    ├ Iam: (documentation changed)
     │    │    └ Scram: (documentation changed)
     │    ├[~] type VpcConnectivityScram
     │    │ ├  - documentation: Details for SASL/SCRAM client authentication for vpcConnectivity.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    └ Enabled: (documentation changed)
     │    └[~] type VpcConnectivityTls
     │      ├  - documentation: Details for client authentication using TLS for vpcConnectivity.
     │      │  + documentation: undefined
     │      └ properties
     │         └ Enabled: (documentation changed)
     ├[~] resource AWS::MSK::Configuration
     │ ├  - documentation: Creates a new MSK configuration. To see an example of how to use this operation, first save the following text to a file and name the file config-file.txt .
     │ │  `auto.create.topics.enable = true zookeeper.connection.timeout.ms = 1000 log.roll.ms = 604800000` 
     │ │  Now run the following Python 3.6 script in the folder where you saved config-file.txt . This script uses the properties specified in config-file.txt to create a configuration named `SalesClusterConfiguration` . This configuration can work with Apache Kafka versions 1.1.1 and 2.1.0.
     │ │  ```PYTHON
     │ │  import boto3 client = boto3.client('kafka') config_file = open('config-file.txt', 'r') server_properties = config_file.read() response = client.create_configuration( Name='SalesClusterConfiguration', Description='The configuration to use on all sales clusters.', KafkaVersions=['1.1.1', '2.1.0'], ServerProperties=server_properties
     │ │  ) print(response)
     │ │  ```
     │ │  + documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-configuration.html
     │ ├ properties
     │ │  ├ Description: (documentation changed)
     │ │  ├ LatestRevision: (documentation changed)
     │ │  ├ Name: (documentation changed)
     │ │  └ ServerProperties: (documentation changed)
     │ └ attributes
     │    ├ LatestRevision.CreationTime: (documentation changed)
     │    ├ LatestRevision.Description: (documentation changed)
     │    └ LatestRevision.Revision: (documentation changed)
     ├[~] resource AWS::MSK::Replicator
     │ ├  - documentation: Resource Type definition for AWS::MSK::Replicator
     │ │  + documentation: Creates the replicator.
     │ ├ properties
     │ │  ├ CurrentVersion: (documentation changed)
     │ │  ├ KafkaClusters: (documentation changed)
     │ │  ├ ReplicatorName: (documentation changed)
     │ │  ├ ServiceExecutionRoleArn: (documentation changed)
     │ │  └ Tags: (documentation changed)
     │ └ types
     │    ├[~] type AmazonMskCluster
     │    │ ├  - documentation: Details of an Amazon MSK cluster.
     │    │ │  + documentation: Details of an Amazon MSK Cluster.
     │    │ └ properties
     │    │    └ MskClusterArn: (documentation changed)
     │    ├[~] type ConsumerGroupReplication
     │    │ ├  - documentation: Configuration relating to consumer group replication.
     │    │ │  + documentation: Details about consumer group replication.
     │    │ └ properties
     │    │    ├ DetectAndCopyNewConsumerGroups: (documentation changed)
     │    │    └ SynchroniseConsumerGroupOffsets: (documentation changed)
     │    ├[~] type KafkaCluster
     │    │ ├  - documentation: Details of a Kafka cluster for replication.
     │    │ │  + documentation: Information about Kafka Cluster to be used as source / target for replication.
     │    │ └ properties
     │    │    ├ AmazonMskCluster: (documentation changed)
     │    │    └ VpcConfig: (documentation changed)
     │    ├[~] type KafkaClusterClientVpcConfig
     │    │ ├  - documentation: Details of an Amazon VPC which has network connectivity to the Kafka cluster.
     │    │ │  + documentation: Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
     │    │ └ properties
     │    │    ├ SecurityGroupIds: (documentation changed)
     │    │    └ SubnetIds: (documentation changed)
     │    ├[~] type ReplicationInfo
     │    │ └ properties
     │    │    ├ SourceKafkaClusterArn: (documentation changed)
     │    │    ├ TargetCompressionType: (documentation changed)
     │    │    ├ TargetKafkaClusterArn: (documentation changed)
     │    │    └ TopicReplication: (documentation changed)
     │    ├[~] type ReplicationStartingPosition
     │    │ └  - documentation: Configuration for specifying the position in the topics to start replicating from.
     │    │    + documentation: Specifies the position in the topics to start replicating from.
     │    ├[~] type ReplicationTopicNameConfiguration
     │    │ ├  - documentation: Configuration for specifying replicated topic names should be the same as their corresponding upstream topics or prefixed with source cluster alias.
     │    │ │  + documentation: Configuration for specifying replicated topic names will be the same as their corresponding upstream topics or prefixed with source cluster alias.
     │    │ └ properties
     │    │    └ Type: (documentation changed)
     │    └[~] type TopicReplication
     │      ├  - documentation: undefined
     │      │  + documentation: Details about topic replication.
     │      └ properties
     │         ├ StartingPosition: (documentation changed)
     │         └ TopicNameConfiguration: (documentation changed)
     ├[~] resource AWS::MSK::ServerlessCluster
     │ ├ properties
     │ │  └ ClientAuthentication: (documentation changed)
     │ └ types
     │    ├[~] type ClientAuthentication
     │    │ ├  - documentation: Includes all client authentication information.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    └ Sasl: (documentation changed)
     │    ├[~] type Iam
     │    │ ├  - documentation: Details for SASL/IAM client authentication.
     │    │ │  + documentation: undefined
     │    │ └ properties
     │    │    └ Enabled: (documentation changed)
     │    └[~] type Sasl
     │      ├  - documentation: Details for client authentication using SASL. To turn on SASL, you must also turn on `EncryptionInTransit` by setting `inCluster` to true. You must set `clientBroker` to either `TLS` or `TLS_PLAINTEXT` . If you choose `TLS_PLAINTEXT` , then you must also set `unauthenticated` to true.
     │      │  + documentation: undefined
     │      └ properties
     │         └ Iam: (documentation changed)
     └[~] resource AWS::MSK::VpcConnection
       ├  - documentation: Create remote VPC connection.
       │  + documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-vpcconnection.html
       └ properties
          ├ ClientSubnets: (documentation changed)
          ├ SecurityGroups: (documentation changed)
          ├ Tags: (documentation changed)
          ├ TargetClusterArn: (documentation changed)
          └ VpcId: (documentation changed)

@aws-cdk-automation aws-cdk-automation added this pull request to the merge queue Sep 17, 2024
Merged via the queue into main with commit f215f25 Sep 17, 2024
11 checks passed
@aws-cdk-automation aws-cdk-automation deleted the update-source/documentation branch September 17, 2024 03:39
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