Skip to content

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/20450696647

------

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

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@github-actions
Copy link
Contributor

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

@github-actions
Copy link
Contributor

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

├[~] service aws-autoscaling
│ └ resources
│    └[~]  resource AWS::AutoScaling::AutoScalingGroup
│       ├ properties
│       │  └ InstanceLifecyclePolicy: (documentation changed)
│       └ types
│          ├[~] type InstanceLifecyclePolicy
│          │ ├      - documentation: undefined
│          │ │      + documentation: The instance lifecycle policy for the Auto Scaling group. This policy controls instance behavior when an instance transitions through its lifecycle states. Configure retention triggers to specify when instances should move to a `Retained` state instead of automatic termination.
│          │ │      For more information, see [Control instance retention with instance lifecycle policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/instance-lifecycle-policy.html) in the *Amazon EC2 Auto Scaling User Guide* .
│          │ └ properties
│          │    └ RetentionTriggers: (documentation changed)
│          ├[~] type LaunchTemplateOverrides
│          │ └ properties
│          │    └ ImageId: (documentation changed)
│          └[~] type RetentionTriggers
│            ├      - documentation: undefined
│            │      + documentation: Defines the specific triggers that cause instances to be retained in a Retained state rather than terminated. Each trigger corresponds to a different failure scenario during the instance lifecycle. This allows fine-grained control over when to preserve instances for manual intervention.
│            └ properties
│               └ TerminateHookAbandon: (documentation changed)
├[~] service aws-billingconductor
│ └ resources
│    └[~]  resource AWS::BillingConductor::BillingGroup
│       └ types
│          └[~] type AccountGrouping
│            └ properties
│               └ ResponsibilityTransferArn: (documentation changed)
├[~] service aws-cases
│ └ resources
│    ├[~]  resource AWS::Cases::CaseRule
│    │  ├      - documentation: A case rule. In the Amazon Connect admin website, case rules are known as case field conditions. Case rules are used to define the situations under which fields should have certain effects (such as required).
│    │  │      + documentation: Creates a new case rule. In the Amazon Connect admin website, case rules are known as *case field conditions* . For more information about case field conditions, see [Add case field conditions to a case template](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html) .
│    │  ├ properties
│    │  │  ├ Description: (documentation changed)
│    │  │  ├ DomainId: (documentation changed)
│    │  │  ├ Name: (documentation changed)
│    │  │  ├ Rule: (documentation changed)
│    │  │  └ Tags: (documentation changed)
│    │  ├ attributes
│    │  │  ├ CaseRuleArn: (documentation changed)
│    │  │  ├ CaseRuleId: (documentation changed)
│    │  │  ├ CreatedTime: (documentation changed)
│    │  │  └ LastModifiedTime: (documentation changed)
│    │  └ types
│    │     ├[~] type BooleanCondition
│    │     │ ├      - documentation: undefined
│    │     │ │      + documentation: Boolean condition for a rule. In the Amazon Connect admin website, case rules are known as *case field conditions* . For more information about case field conditions, see [Add case field conditions to a case template](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html) .
│    │     │ └ properties
│    │     │    ├ EqualTo: (documentation changed)
│    │     │    └ NotEqualTo: (documentation changed)
│    │     ├[~] type BooleanOperands
│    │     │ ├      - documentation: Boolean operands for a condition.
│    │     │ │      + documentation: Boolean operands for a condition. In the Amazon Connect admin website, case rules are known as *case field conditions* . For more information about case field conditions, see [Add case field conditions to a case template](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html) .
│    │     │ └ properties
│    │     │    ├ OperandOne: (documentation changed)
│    │     │    └ OperandTwo: (documentation changed)
│    │     ├[~] type CaseRuleDetails
│    │     │ ├      - documentation: undefined
│    │     │ │      + documentation: Represents what rule type should take place, under what conditions. In the Amazon Connect admin website, case rules are known as *case field conditions* . For more information about case field conditions, see [Add case field conditions to a case template](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html) .
│    │     │ └ properties
│    │     │    ├ Hidden: (documentation changed)
│    │     │    └ Required: (documentation changed)
│    │     ├[~] type HiddenCaseRule
│    │     │ ├      - documentation: Hidden rule type, used to indicate whether a field is hidden
│    │     │ │      + documentation: A rule that controls field visibility based on conditions. Fields can be shown or hidden dynamically based on values in other fields.
│    │     │ └ properties
│    │     │    ├ Conditions: (documentation changed)
│    │     │    └ DefaultValue: (documentation changed)
│    │     ├[~] type OperandOne
│    │     │ ├      - documentation: The left hand operand in the condition.
│    │     │ │      + documentation: Represents the left hand operand in the condition. In the Amazon Connect admin website, case rules are known as *case field conditions* . For more information about case field conditions, see [Add case field conditions to a case template](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html) .
│    │     │ └ properties
│    │     │    └ FieldId: (documentation changed)
│    │     ├[~] type OperandTwo
│    │     │ ├      - documentation: undefined
│    │     │ │      + documentation: Represents the right hand operand in the condition. In the Amazon Connect admin website, case rules are known as *case field conditions* . For more information about case field conditions, see [Add case field conditions to a case template](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html) .
│    │     │ └ properties
│    │     │    ├ BooleanValue: (documentation changed)
│    │     │    ├ DoubleValue: (documentation changed)
│    │     │    ├ EmptyValue: (documentation changed)
│    │     │    └ StringValue: (documentation changed)
│    │     └[~] type RequiredCaseRule
│    │       ├      - documentation: A required rule type, used to indicate whether a field is required.
│    │       │      + documentation: Required rule type, used to indicate whether a field is required. In the Amazon Connect admin website, case rules are known as *case field conditions* . For more information about case field conditions, see [Add case field conditions to a case template](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html) .
│    │       └ properties
│    │          ├ Conditions: (documentation changed)
│    │          └ DefaultValue: (documentation changed)
│    ├[~]  resource AWS::Cases::Domain
│    │  ├      - documentation: A domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Amazon Connect instance can be associated with only one Cases domain.
│    │  │      + documentation: Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Amazon Connect instance can be associated with only one Cases domain.
│    │  │      > This will not associate your connect instance to Cases domain. Instead, use the Amazon Connect [CreateIntegrationAssociation](https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateIntegrationAssociation.html) API. You need specific IAM permissions to successfully associate the Cases domain. For more information, see [Onboard to Cases](https://docs.aws.amazon.com/connect/latest/adminguide/required-permissions-iam-cases.html#onboard-cases-iam) .
│    │  ├ properties
│    │  │  ├ Name: (documentation changed)
│    │  │  └ Tags: (documentation changed)
│    │  └ attributes
│    │     ├ CreatedTime: (documentation changed)
│    │     └ DomainStatus: (documentation changed)
│    ├[~]  resource AWS::Cases::Field
│    │  ├      - documentation: A field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain.
│    │  │      + documentation: Creates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain.
│    │  ├ properties
│    │  │  ├ Description: (documentation changed)
│    │  │  ├ Name: (documentation changed)
│    │  │  ├ Tags: (documentation changed)
│    │  │  └ Type: (documentation changed)
│    │  └ attributes
│    │     ├ CreatedTime: (documentation changed)
│    │     ├ FieldId: (documentation changed)
│    │     ├ LastModifiedTime: (documentation changed)
│    │     └ Namespace: (documentation changed)
│    ├[~]  resource AWS::Cases::Layout
│    │  ├      - documentation: A layout in the Cases domain. Layouts define the following configuration in the top section and More Info tab of the Cases user interface: Fields to display to the users and Field ordering.
│    │  │      + documentation: Creates a layout in the Cases domain. Layouts define the following configuration in the top section and More Info tab of the Cases user interface:
│    │  │      - Fields to display to the users
│    │  │      - Field ordering
│    │  │      > Title and Status fields cannot be part of layouts since they are not configurable.
│    │  ├ properties
│    │  │  ├ Content: (documentation changed)
│    │  │  ├ Name: (documentation changed)
│    │  │  └ Tags: (documentation changed)
│    │  ├ attributes
│    │  │  ├ CreatedTime: (documentation changed)
│    │  │  ├ LastModifiedTime: (documentation changed)
│    │  │  └ LayoutArn: (documentation changed)
│    │  └ types
│    │     ├[~] type BasicLayout
│    │     │ ├      - documentation: Defines the field layout for the agent's case interface. Configures which fields appear in the top panel (immediately visible) and More Info tab (expandable section) of the case view, allowing customization of the agent experience.
│    │     │ │      + documentation: Content specific to `BasicLayout` type. It configures fields in the top panel and More Info tab of agent application.
│    │     │ └ properties
│    │     │    ├ MoreInfo: (documentation changed)
│    │     │    └ TopPanel: (documentation changed)
│    │     ├[~] type FieldGroup
│    │     │ ├      - documentation: Consists of a group of fields and associated properties.
│    │     │ │      + documentation: Object for a group of fields and associated properties.
│    │     │ └ properties
│    │     │    ├ Fields: (documentation changed)
│    │     │    └ Name: (documentation changed)
│    │     ├[~] type FieldItem
│    │     │ ├      - documentation: Field specific properties.
│    │     │ │      + documentation: Object for field related information.
│    │     │ └ properties
│    │     │    └ Id: (documentation changed)
│    │     ├[~] type LayoutContent
│    │     │ ├      - documentation: Defines the layout structure and field organization for the case interface. Specifies which fields appear in the top panel and More Info tab, and their display order.
│    │     │ │      + documentation: Object to store union of different versions of layout content.
│    │     │ └ properties
│    │     │    └ Basic: (documentation changed)
│    │     ├[~] type LayoutSections
│    │     │ ├      - documentation: Sections within a panel or tab of the page layout.
│    │     │ │      + documentation: Ordered list containing different kinds of sections that can be added. A LayoutSections object can only contain one section.
│    │     │ └ properties
│    │     │    └ Sections: (documentation changed)
│    │     └[~] type Section
│    │       └      - documentation: A section can be a grouped list of fields.
│    │              + documentation: This represents a sections within a panel or tab of the page layout.
│    └[~]  resource AWS::Cases::Template
│       ├      - documentation: A template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs.
│       │      + documentation: Creates a template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.
│       │      Other template APIs are:
│       │      - [DeleteTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html)
│       │      - [GetTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html)
│       │      - [ListTemplates](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.html)
│       │      - [UpdateTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_UpdateTemplate.html)
│       ├ properties
│       │  ├ Description: (documentation changed)
│       │  ├ LayoutConfiguration: (documentation changed)
│       │  ├ Name: (documentation changed)
│       │  ├ Rules: (documentation changed)
│       │  ├ Status: (documentation changed)
│       │  └ Tags: (documentation changed)
│       ├ attributes
│       │  ├ CreatedTime: (documentation changed)
│       │  ├ LastModifiedTime: (documentation changed)
│       │  └ TemplateId: (documentation changed)
│       └ types
│          ├[~] type LayoutConfiguration
│          │ ├      - documentation: Specifies the default layout to use when displaying cases created from this template. The layout determines which fields are visible and their arrangement in the agent interface.
│          │ │      + documentation: Object to store configuration of layouts associated to the template.
│          │ └ properties
│          │    └ DefaultLayout: (documentation changed)
│          ├[~] type RequiredField
│          │ ├      - documentation: Wrapper object containing a field identifier
│          │ │      + documentation: List of fields that must have a value provided to create a case.
│          │ └ properties
│          │    └ FieldId: (documentation changed)
│          └[~] type TemplateRule
│            ├      - documentation: Links a case rule to a specific field within this template. When specified, the rule's conditions will be evaluated for the associated field, controlling behavior like required status, visibility, or available options.
│            │      + documentation: An association representing a case rule acting upon a field. In the Amazon Connect admin website, case rules are known as *case field conditions* . For more information about case field conditions, see [Add case field conditions to a case template](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html) .
│            └ properties
│               ├ CaseRuleId: (documentation changed)
│               └ FieldId: (documentation changed)
├[~] service aws-ec2
│ └ resources
│    └[~]  resource AWS::EC2::ClientVpnEndpoint
│       └ properties
│          ├ EndpointIpAddressType: (documentation changed)
│          └ TrafficIpAddressType: (documentation changed)
├[~] service aws-logs
│ └ resources
│    └[~]  resource AWS::Logs::LogGroup
│       └ properties
│          └ DeletionProtectionEnabled: (documentation changed)
├[~] service aws-odb
│ └ resources
│    └[~]  resource AWS::ODB::OdbPeeringConnection
│       └ attributes
│          └ PeerNetworkCidrs: (documentation changed)
├[~] service aws-securityhub
│ └ resources
│    └[~]  resource AWS::SecurityHub::ConnectorV2
│       └ types
│          ├[~] type JiraCloudProviderConfiguration
│          │ ├      - documentation: The initial configuration settings required to establish an integration between Security Hub and Jira Cloud
│          │ │      + documentation: The initial configuration settings required to establish an integration between Security Hub CSPM and Jira Cloud.
│          │ └ properties
│          │    └ ProjectKey: (documentation changed)
│          └[~] type ServiceNowProviderConfiguration
│            ├      - documentation: The initial configuration settings required to establish an integration between Security Hub and ServiceNow ITSM
│            │      + documentation: The initial configuration settings required to establish an integration between Security Hub CSPM and ServiceNow ITSM.
│            └ properties
│               ├ InstanceName: (documentation changed)
│               └ SecretArn: (documentation changed)
└[~] service aws-workspacesweb
  └ resources
     └[~]  resource AWS::WorkSpacesWeb::UserSettings
        └ properties
           └ WebAuthnAllowed: (documentation changed)

@aws-cdk-automation aws-cdk-automation added this pull request to the merge queue Dec 23, 2025
Merged via the queue into main with commit 2b566e9 Dec 23, 2025
13 checks passed
@aws-cdk-automation aws-cdk-automation deleted the update-source/documentation branch December 23, 2025 04:15
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