Package software.amazon.awscdk.services.accountaccess

Class CfnEntitlement

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.accountaccess.CfnEntitlement
All Implemented Interfaces:
IInspectable, IEntitlementRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:01.900Z") @Stability(Stable) public class CfnEntitlement extends CfnResource implements IInspectable, IEntitlementRef
Resource Type definition for AWS::AccountAccess::Entitlement specifying an entitlement for account access.

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.accountaccess.*;
 CfnEntitlement cfnEntitlement = CfnEntitlement.Builder.create(this, "MyCfnEntitlement")
         .applicationArn("applicationArn")
         .entitlement(EntitlementProperty.builder()
                 .principalRole(PrincipalRoleEntitlementProperty.builder()
                         .principal(PrincipalProperty.builder()
                                 .identityCenter(IdentityCenterPrincipalProperty.builder()
                                         .groupId("groupId")
                                         .userId("userId")
                                         .build())
                                 .build())
                         .roleArn("roleArn")
                         // the properties below are optional
                         .account("account")
                         .build())
                 .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

    • CfnEntitlement

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

    • CfnEntitlement

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

    • CfnEntitlement

      @Stability(Stable) public CfnEntitlement(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnEntitlementProps props)
      Create a new AWS::AccountAccess::Entitlement.

      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

    • isCfnEntitlement

      @Stability(Stable) @NotNull public static Boolean isCfnEntitlement(@NotNull Object x)
      Checks whether the given object is a CfnEntitlement.

      Parameters:
      x - This parameter is required.

    • 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.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The timestamp when the entitlement was created.

    • getAttrEntitlementId

      @Stability(Stable) @NotNull public String getAttrEntitlementId()
      The ID of the entitlement.

    • getAttrEntitlementPrincipalRoleAccount

      @Stability(Stable) @NotNull public String getAttrEntitlementPrincipalRoleAccount()
      The AWS account ID.

    • getCfnProperties

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

    • getCfnPropertyNames

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

    • getEntitlementRef

      @Stability(Stable) @NotNull public EntitlementReference getEntitlementRef()
      A reference to a Entitlement resource.
      Specified by:
      getEntitlementRef in interface IEntitlementRef

    • getApplicationArn

      @Stability(Stable) @NotNull public String getApplicationArn()
      The ARN of the application.

    • setApplicationArn

      @Stability(Stable) public void setApplicationArn(@NotNull String value)
      The ARN of the application.

    • getEntitlement

      @Stability(Stable) @NotNull public Object getEntitlement()
      Returns union: either IResolvable or CfnEntitlement.EntitlementProperty

    • setEntitlement

      @Stability(Stable) public void setEntitlement(@NotNull IResolvable value)

    • setEntitlement

      @Stability(Stable) public void setEntitlement(@NotNull CfnEntitlement.EntitlementProperty value)