Package software.amazon.awscdk.services.qbusiness

Class CfnPermission

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.qbusiness.CfnPermission
All Implemented Interfaces:
IInspectable, IPermissionRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:44.812Z") @Stability(Stable) public class CfnPermission extends CfnResource implements IInspectable, IPermissionRef
Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV.

This operation creates a new policy statement for the specified Amazon Q Business application. The policy statement defines the IAM actions that the ISV is allowed to perform on the Amazon Q Business application's resources.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.qbusiness.*;
 CfnPermission cfnPermission = CfnPermission.Builder.create(this, "MyCfnPermission")
         .actions(List.of("actions"))
         .applicationId("applicationId")
         .principal("principal")
         .statementId("statementId")
         // the properties below are optional
         .conditions(List.of(ConditionProperty.builder()
                 .conditionKey("conditionKey")
                 .conditionOperator("conditionOperator")
                 .conditionValues(List.of("conditionValues"))
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnPermission

      protected CfnPermission(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnPermission

      protected CfnPermission(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnPermission

      @Stability(Stable) public CfnPermission(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPermissionProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getPermissionRef

      @Stability(Stable) @NotNull public PermissionReference getPermissionRef()
      A reference to a Permission resource.
      Specified by:
      getPermissionRef in interface IPermissionRef

    • getActions

      @Stability(Stable) @NotNull public List<String> getActions()
      The list of Amazon Q Business actions that the ISV is allowed to perform.

    • setActions

      @Stability(Stable) public void setActions(@NotNull List<String> value)
      The list of Amazon Q Business actions that the ISV is allowed to perform.

    • getApplicationId

      @Stability(Stable) @NotNull public String getApplicationId()
      The unique identifier of the Amazon Q Business application.

    • setApplicationId

      @Stability(Stable) public void setApplicationId(@NotNull String value)
      The unique identifier of the Amazon Q Business application.

    • getPrincipal

      @Stability(Stable) @NotNull public String getPrincipal()
      Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation responses.

    • setPrincipal

      @Stability(Stable) public void setPrincipal(@NotNull String value)
      Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation responses.

    • getStatementId

      @Stability(Stable) @NotNull public String getStatementId()
      A unique identifier for the policy statement.

    • setStatementId

      @Stability(Stable) public void setStatementId(@NotNull String value)
      A unique identifier for the policy statement.

    • getConditions

      @Stability(Stable) @Nullable public Object getConditions()
      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnPermission.ConditionProperty>

    • setConditions

      @Stability(Stable) public void setConditions(@Nullable IResolvable value)

    • setConditions

      @Stability(Stable) public void setConditions(@Nullable List<Object> value)