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

Merged
merged 1 commit into from
Jan 22, 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/7606030014

------

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

Copy link

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

├[~] service aws-batch
│ └ resources
│    └[~] resource AWS::Batch::JobDefinition
│      ├  - documentation: The `AWS::Batch::JobDefinition` resource specifies the parameters for an AWS Batch job definition. For more information, see [Job Definitions](https://docs.aws.amazon.com/batch/latest/userguide/job_definitions.html) in the ** .
│      │  + documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html
│      ├ properties
│      │  ├ ContainerProperties: (documentation changed)
│      │  ├ EksProperties: (documentation changed)
│      │  ├ JobDefinitionName: (documentation changed)
│      │  ├ NodeProperties: (documentation changed)
│      │  ├ Parameters: (documentation changed)
│      │  ├ PlatformCapabilities: (documentation changed)
│      │  ├ PropagateTags: (documentation changed)
│      │  ├ RetryStrategy: (documentation changed)
│      │  ├ SchedulingPriority: (documentation changed)
│      │  ├ Tags: (documentation changed)
│      │  ├ Timeout: (documentation changed)
│      │  └ Type: (documentation changed)
│      ├ attributes
│      │  ├ ContainerOrchestrationType: (documentation changed)
│      │  ├ JobDefinitionArn: (documentation changed)
│      │  ├ Revision: (documentation changed)
│      │  └ Status: (documentation changed)
│      └ types
│         ├[~] type ContainerProperties
│         │ ├  - documentation: Container properties are used for Amazon ECS based job definitions. These properties to describe the container that's launched as part of a job.
│         │ │  + documentation: undefined
│         │ └ properties
│         │    ├ Command: (documentation changed)
│         │    ├ Environment: (documentation changed)
│         │    ├ EphemeralStorage: (documentation changed)
│         │    ├ ExecutionRoleArn: (documentation changed)
│         │    ├ FargatePlatformConfiguration: (documentation changed)
│         │    ├ Image: (documentation changed)
│         │    ├ InstanceType: (documentation changed)
│         │    ├ JobRoleArn: (documentation changed)
│         │    ├ LinuxParameters: (documentation changed)
│         │    ├ LogConfiguration: (documentation changed)
│         │    ├ Memory: (documentation changed)
│         │    ├ MountPoints: (documentation changed)
│         │    ├ NetworkConfiguration: (documentation changed)
│         │    ├ Privileged: (documentation changed)
│         │    ├ ReadonlyRootFilesystem: (documentation changed)
│         │    ├ ResourceRequirements: (documentation changed)
│         │    ├ RuntimePlatform: (documentation changed)
│         │    ├ Secrets: (documentation changed)
│         │    ├ Ulimits: (documentation changed)
│         │    ├ User: (documentation changed)
│         │    ├ Vcpus: (documentation changed)
│         │    └ Volumes: (documentation changed)
│         ├[~] type Device
│         │ ├  - documentation: An object that represents a container instance host device.
│         │ │  > This object isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
│         │ │  + documentation: undefined
│         │ └ properties
│         │    ├ ContainerPath: (documentation changed)
│         │    ├ HostPath: (documentation changed)
│         │    └ Permissions: (documentation changed)
│         ├[~] type EFSAuthorizationConfig
│         │ ├  - documentation: The authorization configuration details for the Amazon EFS file system.
│         │ │  + documentation: undefined
│         │ └ properties
│         │    ├ AccessPointId: (documentation changed)
│         │    └ Iam: (documentation changed)
│         ├[~] type EFSVolumeConfiguration
│         │ ├  - documentation: This is used when you're using an Amazon Elastic File System file system for job storage. For more information, see [Amazon EFS Volumes](https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html) in the *AWS Batch User Guide* .
│         │ │  + documentation: undefined
│         │ └ properties
│         │    ├ AuthorizationConfig: (documentation changed)
│         │    ├ FileSystemId: (documentation changed)
│         │    ├ RootDirectory: (documentation changed)
│         │    ├ TransitEncryption: (documentation changed)
│         │    └ TransitEncryptionPort: (documentation changed)
│         ├[~] type EksContainer
│         │ ├  - documentation: EKS container properties are used in job definitions for Amazon EKS based job definitions to describe the properties for a container node in the pod that's launched as part of a job. This can't be specified for Amazon ECS based job definitions.
│         │ │  + documentation: undefined
│         │ └ properties
│         │    ├ Args: (documentation changed)
│         │    ├ Command: (documentation changed)
│         │    ├ Env: (documentation changed)
│         │    ├ Image: (documentation changed)
│         │    ├ ImagePullPolicy: (documentation changed)
│         │    ├ Name: (documentation changed)
│         │    ├ Resources: (documentation changed)
│         │    ├ SecurityContext: (documentation changed)
│         │    └ VolumeMounts: (documentation changed)
│         ├[~] type EksContainerEnvironmentVariable
│         │ ├  - documentation: An environment variable.
│         │ │  + documentation: undefined
│         │ └ properties
│         │    ├ Name: (documentation changed)
│         │    └ Value: (documentation changed)
│         ├[~] type EksContainerVolumeMount
│         │ ├  - documentation: The volume mounts for a container for an Amazon EKS job. For more information about volumes and volume mounts in Kubernetes, see [Volumes](https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/storage/volumes/) in the *Kubernetes documentation* .
│         │ │  + documentation: undefined
│         │ └ properties
│         │    ├ MountPath: (documentation changed)
│         │    ├ Name: (documentation changed)
│         │    └ ReadOnly: (documentation changed)
│         ├[~] type EksMetadata
│         │ ├  - documentation: Describes and uniquely identifies Kubernetes resources. For example, the compute environment that a pod runs in or the `jobID` for a job running in the pod. For more information, see [Understanding Kubernetes Objects](https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/) in the *Kubernetes documentation* .
│         │ │  + documentation: undefined
│         │ └ properties
│         │    └ Labels: (documentation changed)
│         ├[~] type EksPodProperties
│         │ ├  - documentation: The properties for the pod.
│         │ │  + documentation: undefined
│         │ └ properties
│         │    ├ Containers: (documentation changed)
│         │    ├ DnsPolicy: (documentation changed)
│         │    ├ HostNetwork: (documentation changed)
│         │    ├ Metadata: (documentation changed)
│         │    ├ ServiceAccountName: (documentation changed)
│         │    └ Volumes: (documentation changed)
│         ├[~] type EksProperties
│         │ ├  - documentation: An object that contains the properties for the Kubernetes resources of a job.
│         │ │  + documentation: undefined
│         │ └ properties
│         │    └ PodProperties: (documentation changed)
│         ├[~] type EksSecret
│         │ ├  - documentation: Specifies the configuration of a Kubernetes `secret` volume. For more information, see [secret](https://docs.aws.amazon.com/https://kubernetes.io/docs/concepts/storage/volumes/#secret) in the *Kubernetes documentation* .
│         │ │  + documentation: undefined
│         │ └ properties
│         │    ├ Optional: (documentation changed)
│         │    └ SecretName: (documentation changed)
│         ├[~] type EksVolume
│         │ ├  - documentation: Specifies an Amazon EKS volume for a job definition.
│         │ │  + documentation: undefined
│         │ └ properties
│         │    ├ EmptyDir: (documentation changed)
│         │    ├ HostPath: (documentation changed)
│         │    ├ Name: (documentation changed)
│         │    └ Secret: (documentation changed)
│         ├[~] type Environment
│         │ ├  - documentation: The Environment property type specifies environment variables to use in a job definition.
│         │ │  + documentation: undefined
│         │ └ properties
│         │    ├ Name: (documentation changed)
│         │    └ Value: (documentation changed)
│         ├[~] type EphemeralStorage
│         │ ├  - documentation: The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate .
│         │ │  + documentation: undefined
│         │ └ properties
│         │    └ SizeInGiB: (documentation changed)
│         ├[~] type EvaluateOnExit
│         │ ├  - documentation: Specifies an array of up to 5 conditions to be met, and an action to take ( `RETRY` or `EXIT` ) if all conditions are met. If none of the `EvaluateOnExit` conditions in a `RetryStrategy` match, then the job is retried.
│         │ │  + documentation: undefined
│         │ └ properties
│         │    ├ Action: (documentation changed)
│         │    ├ OnExitCode: (documentation changed)
│         │    ├ OnReason: (documentation changed)
│         │    └ OnStatusReason: (documentation changed)
│         ├[~] type FargatePlatformConfiguration
│         │ ├  - documentation: The platform configuration for jobs that are running on Fargate resources. Jobs that run on EC2 resources must not specify this parameter.
│         │ │  + documentation: undefined
│         │ └ properties
│         │    └ PlatformVersion: (documentation changed)
│         ├[~] type Host
│         │ ├  - documentation: Determine whether your data volume persists on the host container instance and where it's stored. If this parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.
│         │ │  + documentation: undefined
│         │ └ properties
│         │    └ SourcePath: (documentation changed)
│         ├[~] type JobTimeout
│         │ ├  - documentation: An object that represents a job timeout configuration.
│         │ │  + documentation: undefined
│         │ └ properties
│         │    └ AttemptDurationSeconds: (documentation changed)
│         ├[~] type LinuxParameters
│         │ ├  - documentation: Linux-specific modifications that are applied to the container, such as details for device mappings.
│         │ │  + documentation: undefined
│         │ └ properties
│         │    ├ Devices: (documentation changed)
│         │    ├ InitProcessEnabled: (documentation changed)
│         │    ├ MaxSwap: (documentation changed)
│         │    ├ SharedMemorySize: (documentation changed)
│         │    ├ Swappiness: (documentation changed)
│         │    └ Tmpfs: (documentation changed)
│         ├[~] type LogConfiguration
│         │ ├  - documentation: Log configuration options to send to a custom log driver for the container.
│         │ │  + documentation: undefined
│         │ └ properties
│         │    ├ LogDriver: (documentation changed)
│         │    ├ Options: (documentation changed)
│         │    └ SecretOptions: (documentation changed)
│         ├[~] type MountPoint
│         │ ├  - documentation: Details for a Docker volume mount point that's used in a job's container properties. This parameter maps to `Volumes` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerCreate) section of the *Docker Remote API* and the `--volume` option to docker run.
│         │ │  + documentation: undefined
│         │ └ properties
│         │    ├ ContainerPath: (documentation changed)
│         │    ├ ReadOnly: (documentation changed)
│         │    └ SourceVolume: (documentation changed)
│         ├[~] type NetworkConfiguration
│         │ ├  - documentation: The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.
│         │ │  + documentation: undefined
│         │ └ properties
│         │    └ AssignPublicIp: (documentation changed)
│         ├[~] type NodeProperties
│         │ ├  - documentation: An object that represents the node properties of a multi-node parallel job.
│         │ │  > Node properties can't be specified for Amazon EKS based job definitions.
│         │ │  + documentation: undefined
│         │ └ properties
│         │    ├ MainNode: (documentation changed)
│         │    ├ NodeRangeProperties: (documentation changed)
│         │    └ NumNodes: (documentation changed)
│         ├[~] type NodeRangeProperty
│         │ ├  - documentation: An object that represents the properties of the node range for a multi-node parallel job.
│         │ │  + documentation: undefined
│         │ └ properties
│         │    ├ Container: (documentation changed)
│         │    └ TargetNodes: (documentation changed)
│         ├[~] type ResourceRequirement
│         │ ├  - documentation: The type and amount of a resource to assign to a container. The supported resources include `GPU` , `MEMORY` , and `VCPU` .
│         │ │  + documentation: undefined
│         │ └ properties
│         │    ├ Type: (documentation changed)
│         │    └ Value: (documentation changed)
│         ├[~] type RetryStrategy
│         │ ├  - documentation: The retry strategy that's associated with a job. For more information, see [Automated job retries](https://docs.aws.amazon.com/batch/latest/userguide/job_retries.html) in the *AWS Batch User Guide* .
│         │ │  + documentation: undefined
│         │ └ properties
│         │    ├ Attempts: (documentation changed)
│         │    └ EvaluateOnExit: (documentation changed)
│         ├[~] type RuntimePlatform
│         │ ├  - documentation: An object that represents the compute environment architecture for AWS Batch jobs on Fargate.
│         │ │  + documentation: undefined
│         │ └ properties
│         │    ├ CpuArchitecture: (documentation changed)
│         │    └ OperatingSystemFamily: (documentation changed)
│         ├[~] type Secret
│         │ ├  - documentation: An object that represents the secret to expose to your container. Secrets can be exposed to a container in the following ways:
│         │ │  - To inject sensitive data into your containers as environment variables, use the `secrets` container definition parameter.
│         │ │  - To reference sensitive information in the log configuration of a container, use the `secretOptions` container definition parameter.
│         │ │  For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html) in the *AWS Batch User Guide* .
│         │ │  + documentation: undefined
│         │ └ properties
│         │    ├ Name: (documentation changed)
│         │    └ ValueFrom: (documentation changed)
│         ├[~] type Tmpfs
│         │ ├  - documentation: The container path, mount options, and size of the `tmpfs` mount.
│         │ │  > This object isn't applicable to jobs that are running on Fargate resources.
│         │ │  + documentation: undefined
│         │ └ properties
│         │    ├ ContainerPath: (documentation changed)
│         │    ├ MountOptions: (documentation changed)
│         │    └ Size: (documentation changed)
│         ├[~] type Ulimit
│         │ ├  - documentation: The `ulimit` settings to pass to the container. For more information, see [Ulimit](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html) .
│         │ │  > This object isn't applicable to jobs that are running on Fargate resources.
│         │ │  + documentation: undefined
│         │ └ properties
│         │    ├ HardLimit: (documentation changed)
│         │    ├ Name: (documentation changed)
│         │    └ SoftLimit: (documentation changed)
│         └[~] type Volume
│           ├  - documentation: A data volume that's used in a job's container properties.
│           │  + documentation: undefined
│           └ properties
│              ├ EfsVolumeConfiguration: (documentation changed)
│              ├ Host: (documentation changed)
│              └ Name: (documentation changed)
├[~] service aws-codebuild
│ └ resources
│    └[~] resource AWS::CodeBuild::Project
│      └ types
│         └[~] type Environment
│           └ properties
│              └ Type: (documentation changed)
├[~] service aws-datazone
│ └ resources
│    ├[~] resource AWS::DataZone::DataSource
│    │ ├  - documentation: Definition of AWS::DataZone::DataSource Resource Type
│    │ │  + documentation: The `AWS::DataZone::DataSource` resource specifies an Amazon DataZone data source that is used to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone.
│    │ ├ properties
│    │ │  ├ AssetFormsInput: (documentation changed)
│    │ │  ├ Configuration: (documentation changed)
│    │ │  ├ ProjectIdentifier: (documentation changed)
│    │ │  └ Recommendation: (documentation changed)
│    │ ├ attributes
│    │ │  ├ DomainId: (documentation changed)
│    │ │  ├ EnvironmentId: (documentation changed)
│    │ │  ├ Id: (documentation changed)
│    │ │  ├ LastRunAssetCount: (documentation changed)
│    │ │  ├ LastRunAt: (documentation changed)
│    │ │  ├ LastRunStatus: (documentation changed)
│    │ │  ├ ProjectId: (documentation changed)
│    │ │  └ UpdatedAt: (documentation changed)
│    │ └ types
│    │    ├[~] type DataSourceConfigurationInput
│    │    │ ├  - documentation: undefined
│    │    │ │  + documentation: The configuration of the data source.
│    │    │ └ properties
│    │    │    ├ GlueRunConfiguration: (documentation changed)
│    │    │    └ RedshiftRunConfiguration: (documentation changed)
│    │    ├[~] type FilterExpression
│    │    │ ├  - documentation: The search filter expression.
│    │    │ │  + documentation: A filter expression in Amazon DataZone.
│    │    │ └ properties
│    │    │    ├ Expression: (documentation changed)
│    │    │    └ Type: (documentation changed)
│    │    ├[~] type GlueRunConfigurationInput
│    │    │ └  - documentation: undefined
│    │    │    + documentation: The configuration details of the AWS Glue data source.
│    │    ├[~] type RecommendationConfiguration
│    │    │ └  - documentation: The recommendation to be updated as part of the UpdateDataSource action.
│    │    │    + documentation: The recommendation configuration for the data source.
│    │    ├[~] type RedshiftClusterStorage
│    │    │ └  - documentation: The name of an Amazon Redshift cluster.
│    │    │    + documentation: The details of the Amazon Redshift cluster storage.
│    │    ├[~] type RedshiftCredentialConfiguration
│    │    │ └  - documentation: The ARN of a secret manager for an Amazon Redshift cluster.
│    │    │    + documentation: The details of the credentials required to access an Amazon Redshift cluster.
│    │    ├[~] type RedshiftRunConfigurationInput
│    │    │ ├  - documentation: The configuration details of the Amazon Redshift data source.
│    │    │ │  + documentation: The relational filter configurations included in the configuration details of the Amazon Redshift data source.
│    │    │ └ properties
│    │    │    ├ DataAccessRole: (documentation changed)
│    │    │    ├ RedshiftCredentialConfiguration: (documentation changed)
│    │    │    └ RelationalFilterConfigurations: (documentation changed)
│    │    ├[~] type RedshiftStorage
│    │    │ ├  - documentation: The details of the Amazon Redshift cluster source.
│    │    │ │  + documentation: The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.
│    │    │ └ properties
│    │    │    ├ RedshiftClusterSource: (documentation changed)
│    │    │    └ RedshiftServerlessSource: (documentation changed)
│    │    └[~] type ScheduleConfiguration
│    │      ├  - documentation: The schedule of the data source runs.
│    │      │  + documentation: The details of the schedule of the data source runs.
│    │      └ properties
│    │         └ Timezone: (documentation changed)
│    ├[~] resource AWS::DataZone::Domain
│    │ ├  - documentation: A domain is an organizing entity for connecting together assets, users, and their projects
│    │ │  + documentation: The `AWS::DataZone::Domain` resource specifies an Amazon DataZone domain. You can use domains to organize your assets, users, and their projects.
│    │ ├ properties
│    │ │  └ SingleSignOn: (documentation changed)
│    │ ├ attributes
│    │ │  ├ CreatedAt: (documentation changed)
│    │ │  ├ Id: (documentation changed)
│    │ │  ├ LastUpdatedAt: (documentation changed)
│    │ │  └ PortalUrl: (documentation changed)
│    │ └ types
│    │    └[~] type SingleSignOn
│    │      └  - documentation: The single-sign on configuration of the Amazon DataZone domain.
│    │         + documentation: The single sign-on details in Amazon DataZone.
│    ├[~] resource AWS::DataZone::Environment
│    │ ├  - documentation: Definition of AWS::DataZone::Environment Resource Type
│    │ │  + documentation: The `AWS::DataZone::Environment` resource specifies an Amazon DataZone environment, which is a collection of zero or more configured resources with a given set of IAM principals who can operate on those resources.
│    │ ├ properties
│    │ │  ├ Description: (documentation changed)
│    │ │  ├ DomainIdentifier: (documentation changed)
│    │ │  ├ EnvironmentProfileIdentifier: (documentation changed)
│    │ │  ├ GlossaryTerms: (documentation changed)
│    │ │  ├ Name: (documentation changed)
│    │ │  ├ ProjectIdentifier: (documentation changed)
│    │ │  └ UserParameters: (documentation changed)
│    │ ├ attributes
│    │ │  ├ AwsAccountId: (documentation changed)
│    │ │  ├ AwsAccountRegion: (documentation changed)
│    │ │  ├ DomainId: (documentation changed)
│    │ │  ├ EnvironmentBlueprintId: (documentation changed)
│    │ │  ├ EnvironmentProfileId: (documentation changed)
│    │ │  ├ Id: (documentation changed)
│    │ │  ├ ProjectId: (documentation changed)
│    │ │  ├ Provider: (documentation changed)
│    │ │  └ Status: (documentation changed)
│    │ └ types
│    │    └[~] type EnvironmentParameter
│    │      ├  - documentation: The parameter details of an environment.
│    │      │  + documentation: The parameter details of the environment.
│    │      └ properties
│    │         ├ Name: (documentation changed)
│    │         └ Value: (documentation changed)
│    ├[~] resource AWS::DataZone::EnvironmentBlueprintConfiguration
│    │ ├  - documentation: Definition of AWS::DataZone::EnvironmentBlueprintConfiguration Resource Type
│    │ │  + documentation: The configuration details of an environment blueprint.
│    │ ├ properties
│    │ │  ├ DomainIdentifier: (documentation changed)
│    │ │  ├ EnabledRegions: (documentation changed)
│    │ │  ├ EnvironmentBlueprintIdentifier: (documentation changed)
│    │ │  ├ ManageAccessRoleArn: (documentation changed)
│    │ │  ├ ProvisioningRoleArn: (documentation changed)
│    │ │  └ RegionalParameters: (documentation changed)
│    │ ├ attributes
│    │ │  ├ CreatedAt: (documentation changed)
│    │ │  ├ DomainId: (documentation changed)
│    │ │  ├ EnvironmentBlueprintId: (documentation changed)
│    │ │  └ UpdatedAt: (documentation changed)
│    │ └ types
│    │    └[~] type RegionalParameter
│    │      ├  - documentation: undefined
│    │      │  + documentation: The regional parameters in the environment blueprint.
│    │      └ properties
│    │         ├ Parameters: (documentation changed)
│    │         └ Region: (documentation changed)
│    ├[~] resource AWS::DataZone::EnvironmentProfile
│    │ ├  - documentation: AWS Datazone Environment Profile is pre-configured set of resources and blueprints that provide reusable templates for creating environments.
│    │ │  + documentation: The details of an environment profile.
│    │ ├ properties
│    │ │  ├ AwsAccountId: (documentation changed)
│    │ │  ├ AwsAccountRegion: (documentation changed)
│    │ │  ├ Description: (documentation changed)
│    │ │  ├ DomainIdentifier: (documentation changed)
│    │ │  ├ EnvironmentBlueprintIdentifier: (documentation changed)
│    │ │  ├ Name: (documentation changed)
│    │ │  └ ProjectIdentifier: (documentation changed)
│    │ ├ attributes
│    │ │  ├ CreatedAt: (documentation changed)
│    │ │  ├ CreatedBy: (documentation changed)
│    │ │  ├ DomainId: (documentation changed)
│    │ │  ├ EnvironmentBlueprintId: (documentation changed)
│    │ │  ├ Id: (documentation changed)
│    │ │  ├ ProjectId: (documentation changed)
│    │ │  └ UpdatedAt: (documentation changed)
│    │ └ types
│    │    └[~] type EnvironmentParameter
│    │      └ properties
│    │         ├ Name: (documentation changed)
│    │         └ Value: (documentation changed)
│    ├[~] resource AWS::DataZone::Project
│    │ ├  - documentation: Amazon DataZone projects are business use case–based groupings of people, assets (data), and tools used to simplify access to the AWS analytics.
│    │ │  + documentation: The `AWS::DataZone::Project` resource specifies an Amazon DataZone project. Projects enable a group of users to collaborate on various business use cases that involve publishing, discovering, subscribing to, and consuming data in the Amazon DataZone catalog. Project members consume assets from the Amazon DataZone catalog and produce new assets using one or more analytical workflows.
│    │ ├ properties
│    │ │  ├ Description: (documentation changed)
│    │ │  ├ DomainIdentifier: (documentation changed)
│    │ │  └ Name: (documentation changed)
│    │ └ attributes
│    │    ├ CreatedAt: (documentation changed)
│    │    ├ DomainId: (documentation changed)
│    │    └ Id: (documentation changed)
│    └[~] resource AWS::DataZone::SubscriptionTarget
│      ├  - documentation: Subscription targets enables one to access the data to which you have subscribed in your projects.
│      │  + documentation: The `AWS::DataZone::SubscriptionTarget` resource specifies an Amazon DataZone subscription target. Subscription targets enable you to access the data to which you have subscribed in your projects. A subscription target specifies the location (for example, a database or a schema) and the required permissions (for example, an IAM role) that Amazon DataZone can use to establish a connection with the source data and to create the necessary grants so that members of the Amazon DataZone project can start querying the data to which they have subscribed.
│      ├ properties
│      │  ├ ApplicableAssetTypes: (documentation changed)
│      │  ├ AuthorizedPrincipals: (documentation changed)
│      │  ├ DomainIdentifier: (documentation changed)
│      │  └ EnvironmentIdentifier: (documentation changed)
│      └ attributes
│         ├ DomainId: (documentation changed)
│         ├ EnvironmentId: (documentation changed)
│         └ Id: (documentation changed)
├[~] service aws-elasticloadbalancingv2
│ └ resources
│    └[~] resource AWS::ElasticLoadBalancingV2::LoadBalancer
│      └ properties
│         └ EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic: (documentation changed)
├[~] service aws-fis
│ └ resources
│    └[~] resource AWS::FIS::ExperimentTemplate
│      ├  - documentation: Specifies an experiment template.
│      │  An experiment template includes the following components:
│      │  - *Targets* : A target can be a specific resource in your AWS environment, or one or more resources that match criteria that you specify, for example, resources that have specific tags.
│      │  - *Actions* : The actions to carry out on the target. You can specify multiple actions, the duration of each action, and when to start each action during an experiment.
│      │  - *Stop conditions* : If a stop condition is triggered while an experiment is running, the experiment is automatically stopped. You can define a stop condition as a CloudWatch alarm.
│      │  For more information, see [Experiment templates](https://docs.aws.amazon.com/fis/latest/userguide/experiment-templates.html) in the *AWS Fault Injection Service User Guide* .
│      │  + documentation: Describes an experiment template.
│      └ types
│         ├[~] type ExperimentTemplateAction
│         │ └  - documentation: Specifies an action for an experiment template.
│         │    For more information, see [Actions](https://docs.aws.amazon.com/fis/latest/userguide/actions.html) in the *AWS Fault Injection Service User Guide* .
│         │    + documentation: Describes an action for an experiment template.
│         ├[~] type ExperimentTemplateLogConfiguration
│         │ ├  - documentation: Specifies the configuration for experiment logging.
│         │ │  For more information, see [Experiment logging](https://docs.aws.amazon.com/fis/latest/userguide/monitoring-logging.html) in the *AWS Fault Injection Service User Guide* .
│         │ │  + documentation: Describes the configuration for experiment logging.
│         │ └ properties
│         │    ├ CloudWatchLogsConfiguration: (documentation changed)
│         │    └ S3Configuration: (documentation changed)
│         ├[~] type ExperimentTemplateStopCondition
│         │ └  - documentation: Specifies a stop condition for an experiment template.
│         │    For more information, see [Stop conditions](https://docs.aws.amazon.com/fis/latest/userguide/stop-conditions.html) in the *AWS Fault Injection Service User Guide* .
│         │    + documentation: Describes a stop condition for an experiment template.
│         ├[~] type ExperimentTemplateTarget
│         │ ├  - documentation: Specifies a target for an experiment. You must specify at least one Amazon Resource Name (ARN) or at least one resource tag. You cannot specify both ARNs and tags.
│         │ │  For more information, see [Targets](https://docs.aws.amazon.com/fis/latest/userguide/targets.html) in the *AWS Fault Injection Service User Guide* .
│         │ │  + documentation: Describes a target for an experiment template.
│         │ └ properties
│         │    └ Parameters: (documentation changed)
│         └[~] type ExperimentTemplateTargetFilter
│           └  - documentation: Specifies a filter used for the target resource input in an experiment template.
│              For more information, see [Resource filters](https://docs.aws.amazon.com/fis/latest/userguide/targets.html#target-filters) in the *AWS Fault Injection Service User Guide* .
│              + documentation: Describes a filter used for the target resources in an experiment template.
├[~] service aws-ivs
│ └ resources
│    ├[~] resource AWS::IVS::Channel
│    │ └  - documentation: The `AWS::IVS::Channel` resource specifies an  channel. A channel stores configuration information related to your live stream. For more information, see [CreateChannel](https://docs.aws.amazon.com/ivs/latest/APIReference/API_CreateChannel.html) in the *Amazon Interactive Video Service API Reference* .
│    │    > By default, the IVS API CreateChannel endpoint creates a stream key in addition to a channel. The  Channel resource *does not* create a stream key; to create a stream key, use the StreamKey resource instead.
│    │    + documentation: The `AWS::IVS::Channel` resource specifies an  channel. A channel stores configuration information related to your live stream. For more information, see [CreateChannel](https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/API_CreateChannel.html) in the *Amazon IVS Low-Latency Streaming API Reference* .
│    │    > By default, the IVS API CreateChannel endpoint creates a stream key in addition to a channel. The  Channel resource *does not* create a stream key; to create a stream key, use the StreamKey resource instead.
│    ├[~] resource AWS::IVS::PlaybackKeyPair
│    │ └  - documentation: The `AWS::IVS::PlaybackKeyPair` resource specifies an  playback key pair.  uses a public playback key to validate playback tokens that have been signed with the corresponding private key. For more information, see [Setting Up Private Channels](https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html) in the *Amazon Interactive Video Service User Guide* .
│    │    + documentation: The `AWS::IVS::PlaybackKeyPair` resource specifies an  playback key pair.  uses a public playback key to validate playback tokens that have been signed with the corresponding private key. For more information, see [Setting Up Private Channels](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/private-channels.html) in the *Amazon IVS Low-Latency Streaming User Guide* .
│    ├[~] resource AWS::IVS::RecordingConfiguration
│    │ ├  - documentation: The `AWS::IVS::RecordingConfiguration` resource specifies an  recording configuration. A recording configuration enables the recording of a channel’s live streams to a data store. Multiple channels can reference the same recording configuration. For more information, see [RecordingConfiguration](https://docs.aws.amazon.com/ivs/latest/APIReference/API_RecordingConfiguration.html) in the *Amazon Interactive Video Service API Reference* .
│    │ │  + documentation: The `AWS::IVS::RecordingConfiguration` resource specifies an  recording configuration. A recording configuration enables the recording of a channel’s live streams to a data store. Multiple channels can reference the same recording configuration. For more information, see [RecordingConfiguration](https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/API_RecordingConfiguration.html) in the *Amazon IVS Low-Latency Streaming API Reference* .
│    │ └ types
│    │    ├[~] type RenditionConfiguration
│    │    │ └ properties
│    │    │    └ Renditions: (documentation changed)
│    │    └[~] type ThumbnailConfiguration
│    │      └ properties
│    │         ├ Resolution: (documentation changed)
│    │         └ TargetIntervalSeconds: (documentation changed)
│    └[~] resource AWS::IVS::Stage
│      ├  - documentation: Resource Definition for type AWS::IVS::Stage.
│      │  + documentation: The `AWS::IVS::Stage` resource specifies an  stage. A stage is a virtual space where participants can exchange video in real time. For more information, see [CreateStage](https://docs.aws.amazon.com/ivs/latest/RealTimeAPIReference/API_CreateStage.html) in the *Amazon IVS Real-Time Streaming API Reference* .
│      ├ properties
│      │  ├ Name: (documentation changed)
│      │  └ Tags: (documentation changed)
│      └ attributes
│         ├ ActiveSessionId: (documentation changed)
│         └ Arn: (documentation changed)
└[~] service aws-rolesanywhere
  └ resources
     ├[~] resource AWS::RolesAnywhere::Profile
     │ ├  - documentation: Creates a 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` .
     │ └ 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 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` .
       └ types
          ├[~] type Source
          │ ├  - documentation: Object representing the TrustAnchor type and its related certificate data.
          │ │  + documentation: The trust anchor type and its related certificate data.
          │ └ properties
          │    ├ SourceData: (documentation changed)
          │    └ SourceType: (documentation changed)
          └[~] type SourceData
            └  - documentation: A union object representing the data field of the TrustAnchor depending on its type
               + documentation: The data field of the trust anchor depending on its type.

@aws-cdk-automation aws-cdk-automation added this pull request to the merge queue Jan 22, 2024
Merged via the queue into main with commit e3ff4bf Jan 22, 2024
11 checks passed
@aws-cdk-automation aws-cdk-automation deleted the update-source/documentation branch January 22, 2024 03:36
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