Package software.amazon.awscdk.services.iam

Interface IIdentity.Jsii$Default

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IGrantable, IGrantable.Jsii$Default, IIdentity, IPrincipal, IPrincipal.Jsii$Default, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IGroup.Jsii$Default, IRole.Jsii$Default, IUser.Jsii$Default
All Known Implementing Classes:
IGroup.Jsii$Proxy, IIdentity.Jsii$Proxy, IRole.Jsii$Proxy, IUser.Jsii$Proxy
Enclosing interface:
IIdentity
@Internal public static interface IIdentity.Jsii$Default extends IIdentity, IResource.Jsii$Default, IPrincipal.Jsii$Default
Internal default implementation for IIdentity.

  • Method Details

    • getGrantPrincipal

      @Stability(Stable) @NotNull default IPrincipal getGrantPrincipal()
      The principal to grant permissions to.
      Specified by:
      getGrantPrincipal in interface IGrantable
      Specified by:
      getGrantPrincipal in interface IGrantable.Jsii$Default
      Specified by:
      getGrantPrincipal in interface IPrincipal.Jsii$Default

    • getAssumeRoleAction

      @Stability(Stable) @NotNull default String getAssumeRoleAction()
      When this Principal is used in an AssumeRole policy, the action to use.
      Specified by:
      getAssumeRoleAction in interface IPrincipal
      Specified by:
      getAssumeRoleAction in interface IPrincipal.Jsii$Default

    • getPolicyFragment

      @Stability(Stable) @NotNull default PrincipalPolicyFragment getPolicyFragment()
      Return the policy fragment that identifies this principal in a Policy.
      Specified by:
      getPolicyFragment in interface IPrincipal
      Specified by:
      getPolicyFragment in interface IPrincipal.Jsii$Default

    • getPrincipalAccount

      @Stability(Stable) @Nullable default String getPrincipalAccount()
      The AWS account ID of this principal.

      Can be undefined when the account is not known (for example, for service principals). Can be a Token - in that case, it's assumed to be AWS::AccountId.

      Specified by:
      getPrincipalAccount in interface IPrincipal
      Specified by:
      getPrincipalAccount in interface IPrincipal.Jsii$Default

    • getNode

      @Stability(Stable) @NotNull default software.constructs.Node getNode()
      The tree node.
      Specified by:
      getNode in interface software.constructs.IConstruct
      Specified by:
      getNode in interface software.constructs.IConstruct.Jsii$Default
      Specified by:
      getNode in interface IResource.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull default ResourceEnvironment getEnv()
      The environment this resource belongs to.

      For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

      Specified by:
      getEnv in interface IResource
      Specified by:
      getEnv in interface IResource.Jsii$Default

    • getStack

      @Stability(Stable) @NotNull default Stack getStack()
      The stack in which this resource is defined.
      Specified by:
      getStack in interface IResource
      Specified by:
      getStack in interface IResource.Jsii$Default

    • addToPrincipalPolicy

      @Stability(Stable) @NotNull default AddToPrincipalPolicyResult addToPrincipalPolicy(@NotNull PolicyStatement statement)
      Add to the policy of this principal.

      Specified by:
      addToPrincipalPolicy in interface IPrincipal
      Specified by:
      addToPrincipalPolicy in interface IPrincipal.Jsii$Default
      Parameters:
      statement - This parameter is required.

    • applyRemovalPolicy

      @Stability(Stable) default void applyRemovalPolicy(@NotNull RemovalPolicy policy)
      Apply the given removal policy to this resource.

      The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

      The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

      Specified by:
      applyRemovalPolicy in interface IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Parameters:
      policy - This parameter is required.

    • addManagedPolicy

      @Stability(Stable) default void addManagedPolicy(@NotNull IManagedPolicy policy)
      Attaches a managed policy to this principal.

      Specified by:
      addManagedPolicy in interface IIdentity
      Parameters:
      policy - The managed policy. This parameter is required.

    • attachInlinePolicy

      @Stability(Stable) default void attachInlinePolicy(@NotNull Policy policy)
      Attaches an inline policy to this principal.

      This is the same as calling policy.addToXxx(principal).

      Specified by:
      attachInlinePolicy in interface IIdentity
      Parameters:
      policy - The policy resource to attach to this principal [disable-awslint:ref-via-interface]. This parameter is required.