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

Merged
merged 1 commit into from
Dec 24, 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/12476380317

------

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

Copy link

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

├[~] service aws-ec2
│ └ resources
│    ├[~]  resource AWS::EC2::EC2Fleet
│    │  └ types
│    │     └[~] type PerformanceFactorReferenceRequest
│    │       └ properties
│    │          └ InstanceFamily: (documentation changed)
│    └[~]  resource AWS::EC2::SpotFleet
│       └ types
│          └[~] type PerformanceFactorReferenceRequest
│            └ properties
│               └ InstanceFamily: (documentation changed)
├[~] service aws-eks
│ └ resources
│    ├[~]  resource AWS::EKS::Addon
│    │  └ properties
│    │     └ PodIdentityAssociations: (documentation changed)
│    ├[~]  resource AWS::EKS::Cluster
│    │  ├ properties
│    │  │  ├ ComputeConfig: (documentation changed)
│    │  │  ├ StorageConfig: (documentation changed)
│    │  │  └ UpgradePolicy: (documentation changed)
│    │  └ types
│    │     ├[~] type BlockStorage
│    │     │ └      - documentation: Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your AWS account. For more information, see EKS Auto Mode block storage capability in the EKS User Guide.
│    │     │        + documentation: Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your AWS account. For more information, see EKS Auto Mode block storage capability in the *Amazon EKS User Guide* .
│    │     ├[~] type ComputeConfig
│    │     │ ├      - documentation: Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your AWS account. For more information, see EKS Auto Mode compute capability in the EKS User Guide.
│    │     │ │      + documentation: Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your AWS account. For more information, see EKS Auto Mode compute capability in the *Amazon EKS User Guide* .
│    │     │ └ properties
│    │     │    ├ NodePools: (documentation changed)
│    │     │    └ NodeRoleArn: (documentation changed)
│    │     ├[~] type ControlPlanePlacement
│    │     │ └      - documentation: The placement configuration for all the control plane instances of your local Amazon EKS cluster on an AWS Outpost. For more information, see [Capacity considerations](https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html) in the Amazon EKS User Guide.
│    │     │        + documentation: The placement configuration for all the control plane instances of your local Amazon EKS cluster on an AWS Outpost. For more information, see [Capacity considerations](https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html) in the *Amazon EKS User Guide* .
│    │     ├[~] type ElasticLoadBalancing
│    │     │ └      - documentation: Indicates the current configuration of the load balancing capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. For more information, see EKS Auto Mode load balancing capability in the EKS User Guide.
│    │     │        + documentation: Indicates the current configuration of the load balancing capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. For more information, see EKS Auto Mode load balancing capability in the *Amazon EKS User Guide* .
│    │     ├[~] type KubernetesNetworkConfig
│    │     │ └ properties
│    │     │    ├ ElasticLoadBalancing: (documentation changed)
│    │     │    └ IpFamily: (documentation changed)
│    │     ├[~] type StorageConfig
│    │     │ └      - documentation: Request to update the configuration of the storage capability of your EKS Auto Mode cluster. For example, enable the capability. For more information, see EKS Auto Mode block storage capability in the EKS User Guide.
│    │     │        + documentation: Request to update the configuration of the storage capability of your EKS Auto Mode cluster. For example, enable the capability. For more information, see EKS Auto Mode block storage capability in the *Amazon EKS User Guide* .
│    │     └[~] type UpgradePolicy
│    │       ├      - documentation: The support policy to use for the cluster. Extended support allows you to remain on specific Kubernetes versions for longer. Clusters in extended support have higher costs. The default value is `EXTENDED` . Use `STANDARD` to disable extended support.
│    │       │      [Learn more about EKS Extended Support in the EKS User Guide.](https://docs.aws.amazon.com/eks/latest/userguide/extended-support-control.html)
│    │       │      + documentation: The support policy to use for the cluster. Extended support allows you to remain on specific Kubernetes versions for longer. Clusters in extended support have higher costs. The default value is `EXTENDED` . Use `STANDARD` to disable extended support.
│    │       │      [Learn more about EKS Extended Support in the *Amazon EKS User Guide* .](https://docs.aws.amazon.com/eks/latest/userguide/extended-support-control.html)
│    │       └ properties
│    │          └ SupportType: (documentation changed)
│    ├[~]  resource AWS::EKS::FargateProfile
│    │  └      - documentation: Creates an AWS Fargate profile for your Amazon EKS cluster. You must have at least one Fargate profile in a cluster to be able to run pods on Fargate.
│    │         The Fargate profile allows an administrator to declare which pods run on Fargate and specify which pods run on which Fargate profile. This declaration is done through the profile’s selectors. Each profile can have up to five selectors that contain a namespace and labels. A namespace is required for every selector. The label field consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is run on Fargate.
│    │         When you create a Fargate profile, you must specify a pod execution role to use with the pods that are scheduled with the profile. This role is added to the cluster's Kubernetes [Role Based Access Control](https://docs.aws.amazon.com/https://kubernetes.io/docs/reference/access-authn-authz/rbac/) (RBAC) for authorization so that the `kubelet` that is running on the Fargate infrastructure can register with your Amazon EKS cluster so that it can appear in your cluster as a node. The pod execution role also provides IAM permissions to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For more information, see [Pod Execution Role](https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) in the *Amazon EKS User Guide* .
│    │         Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and then delete the original after the updated profile has finished creating.
│    │         If any Fargate profiles in a cluster are in the `DELETING` status, you must wait for that Fargate profile to finish deleting before you can create any other profiles in that cluster.
│    │         For more information, see [AWS Fargate profile](https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html) in the *Amazon EKS User Guide* .
│    │         + documentation: Creates an AWS Fargate profile for your Amazon EKS cluster. You must have at least one Fargate profile in a cluster to be able to run pods on Fargate.
│    │         The Fargate profile allows an administrator to declare which pods run on Fargate and specify which pods run on which Fargate profile. This declaration is done through the profile's selectors. Each profile can have up to five selectors that contain a namespace and labels. A namespace is required for every selector. The label field consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is run on Fargate.
│    │         When you create a Fargate profile, you must specify a pod execution role to use with the pods that are scheduled with the profile. This role is added to the cluster's Kubernetes [Role Based Access Control](https://docs.aws.amazon.com/https://kubernetes.io/docs/reference/access-authn-authz/rbac/) (RBAC) for authorization so that the `kubelet` that is running on the Fargate infrastructure can register with your Amazon EKS cluster so that it can appear in your cluster as a node. The pod execution role also provides IAM permissions to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For more information, see [Pod Execution Role](https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) in the *Amazon EKS User Guide* .
│    │         Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and then delete the original after the updated profile has finished creating.
│    │         If any Fargate profiles in a cluster are in the `DELETING` status, you must wait for that Fargate profile to finish deleting before you can create any other profiles in that cluster.
│    │         For more information, see [AWS Fargate profile](https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html) in the *Amazon EKS User Guide* .
│    └[~]  resource AWS::EKS::IdentityProviderConfig
│       └      - documentation: Associates an identity provider configuration to a cluster.
│              If you want to authenticate identities using an identity provider, you can create an identity provider configuration and associate it to your cluster. After configuring authentication to your cluster you can create Kubernetes `Role` and `ClusterRole` objects, assign permissions to them, and then bind them to the identities using Kubernetes `RoleBinding` and `ClusterRoleBinding` objects. For more information see [Using RBAC Authorization](https://docs.aws.amazon.com/https://kubernetes.io/docs/reference/access-authn-authz/rbac/) in the Kubernetes documentation.
│              + documentation: Associates an identity provider configuration to a cluster.
│              If you want to authenticate identities using an identity provider, you can create an identity provider configuration and associate it to your cluster. After configuring authentication to your cluster you can create Kubernetes `Role` and `ClusterRole` objects, assign permissions to them, and then bind them to the identities using Kubernetes `RoleBinding` and `ClusterRoleBinding` objects. For more information see [Using RBAC Authorization](https://docs.aws.amazon.com/https://Kubernetes.io/docs/reference/access-authn-authz/rbac/) in the Kubernetes documentation.
├[~] service aws-logs
│ └ resources
│    ├[~]  resource AWS::Logs::AccountPolicy
│    │  └ properties
│    │     └ SelectionCriteria: (documentation changed)
│    └[~]  resource AWS::Logs::Transformer
│       └ properties
│          ├ LogGroupIdentifier: (documentation changed)
│          └ TransformerConfig: (documentation changed)
├[~] service aws-quicksight
│ └ resources
│    ├[~]  resource AWS::QuickSight::CustomPermissions
│    │  └ properties
│    │     ├ AwsAccountId: (documentation changed)
│    │     └ Tags: (documentation changed)
│    └[~]  resource AWS::QuickSight::DataSet
│       └ types
│          └[~] type UploadSettings
│            ├      - documentation: <p>Information about the format for a source file or files.</p>
│            │      + documentation: Information about the format for a source file or files.
│            └ properties
│               ├ ContainsHeader: (documentation changed)
│               ├ Delimiter: (documentation changed)
│               ├ Format: (documentation changed)
│               ├ StartFromRow: (documentation changed)
│               └ TextQualifier: (documentation changed)
└[~] service aws-sagemaker
  └ resources
     ├[~]  resource AWS::SageMaker::Domain
     │  └ types
     │     ├[~] type CustomFileSystemConfig
     │     │ └ properties
     │     │    └ FSxLustreFileSystemConfig: (documentation changed)
     │     └[~] type FSxLustreFileSystemConfig
     │       ├      - documentation: undefined
     │       │      + documentation: The settings for assigning a custom Amazon FSx for Lustre file system to a user profile or space for an Amazon SageMaker Domain.
     │       └ properties
     │          ├ FileSystemId: (documentation changed)
     │          └ FileSystemPath: (documentation changed)
     ├[~]  resource AWS::SageMaker::Space
     │  └ types
     │     ├[~] type CustomFileSystem
     │     │ └ properties
     │     │    └ FSxLustreFileSystem: (documentation changed)
     │     ├[~] type FSxLustreFileSystem
     │     │ ├      - documentation: undefined
     │     │ │      + documentation: A custom file system in Amazon FSx for Lustre.
     │     │ └ properties
     │     │    └ FileSystemId: (documentation changed)
     │     └[~] type SpaceSettings
     │       └ properties
     │          └ AppType: (documentation changed)
     └[~]  resource AWS::SageMaker::UserProfile
        └ types
           ├[~] type CustomFileSystemConfig
           │ └ properties
           │    └ FSxLustreFileSystemConfig: (documentation changed)
           └[~] type FSxLustreFileSystemConfig
             ├      - documentation: undefined
             │      + documentation: The settings for assigning a custom Amazon FSx for Lustre file system to a user profile or space for an Amazon SageMaker Domain.
             └ properties
                ├ FileSystemId: (documentation changed)
                └ FileSystemPath: (documentation changed)

@aws-cdk-automation aws-cdk-automation added this pull request to the merge queue Dec 24, 2024
Merged via the queue into main with commit bacb75c Dec 24, 2024
11 checks passed
@aws-cdk-automation aws-cdk-automation deleted the update-source/documentation branch December 24, 2024 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