Package software.amazon.awscdk.services.lambda

Class Permission.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.lambda.Permission.Jsii$Proxy
All Implemented Interfaces:
Permission, software.amazon.jsii.JsiiSerializable
Enclosing interface:
Permission
@Stability(Stable) @Internal public static final class Permission.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements Permission
An implementation for Permission

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.lambda.Permission

    Permission.Builder, Permission.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(Permission.Builder builder)
    Constructor that initializes the object based on literal property values passed by the Permission.Builder.
    protected
    Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
    Constructor that initializes the object based on values retrieved from the JsiiObject.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
    $jsii$toJson()
     
    final boolean
    equals(Object o)
     
    final String
    getAction()
    The Lambda actions that you want to allow in this statement.
    final String
    getEventSourceToken()
    A unique token that must be supplied by the principal invoking the function.
    final FunctionUrlAuthType
    getFunctionUrlAuthType()
    The authType for the function URL that you are granting permissions for.
    final Boolean
    getInvokedViaFunctionUrl()
    The condition key for limiting the scope of lambda:InvokeFunction action to Function URL only.
    final String
    getOrganizationId()
    The organization you want to grant permissions to.
    final IPrincipal
    getPrincipal()
    The entity for which you are granting permission to invoke the Lambda function.
    final software.constructs.Construct
    getScope()
    The scope to which the permission constructs be attached.
    final String
    getSourceAccount()
    The AWS account ID (without hyphens) of the source owner.
    final String
    getSourceArn()
    The ARN of a resource that is invoking your function.
    final int
    hashCode()
     

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(Permission.Builder builder)
      Constructor that initializes the object based on literal property values passed by the Permission.Builder.

  • Method Details

    • getPrincipal

      public final IPrincipal getPrincipal()
      Description copied from interface: Permission
      The entity for which you are granting permission to invoke the Lambda function.

      This entity can be any of the following:

      • a valid AWS service principal, such as s3.amazonaws.com or sns.amazonaws.com
      • an AWS account ID for cross-account permissions. For example, you might want to allow a custom application in another AWS account to push events to Lambda by invoking your function.
      • an AWS organization principal to grant permissions to an entire organization.

      The principal can be an AccountPrincipal, an ArnPrincipal, a ServicePrincipal, or an OrganizationPrincipal.

      Specified by:
      getPrincipal in interface Permission

    • getAction

      public final String getAction()
      Description copied from interface: Permission
      The Lambda actions that you want to allow in this statement.

      For example, you can specify lambda:CreateFunction to specify a certain action, or use a wildcard (lambda:*) to grant permission to all Lambda actions. For a list of actions, see Actions and Condition Context Keys for AWS Lambda in the IAM User Guide.

      Default: 'lambda:InvokeFunction'

      Specified by:
      getAction in interface Permission

    • getEventSourceToken

      public final String getEventSourceToken()
      Description copied from interface: Permission
      A unique token that must be supplied by the principal invoking the function.

      Default: - The caller would not need to present a token.

      Specified by:
      getEventSourceToken in interface Permission

    • getFunctionUrlAuthType

      public final FunctionUrlAuthType getFunctionUrlAuthType()
      Description copied from interface: Permission
      The authType for the function URL that you are granting permissions for.

      Default: - No functionUrlAuthType

      Specified by:
      getFunctionUrlAuthType in interface Permission

    • getInvokedViaFunctionUrl

      public final Boolean getInvokedViaFunctionUrl()
      Description copied from interface: Permission
      The condition key for limiting the scope of lambda:InvokeFunction action to Function URL only.

      When set to true, it restricts the principal in this policy to perform invokes for the resource only via Function URLs.

      Default: - false

      Specified by:
      getInvokedViaFunctionUrl in interface Permission

    • getOrganizationId

      public final String getOrganizationId()
      Description copied from interface: Permission
      The organization you want to grant permissions to.

      Use this ONLY if you need to grant permissions to a subset of the organization. If you want to grant permissions to the entire organization, sending the organization principal through the principal property will suffice.

      You can use this property to ensure that all source principals are owned by a specific organization.

      Default: - No organizationId

      Specified by:
      getOrganizationId in interface Permission

    • getScope

      public final software.constructs.Construct getScope()
      Description copied from interface: Permission
      The scope to which the permission constructs be attached.

      The default is the Lambda function construct itself, but this would need to be different in cases such as cross-stack references where the Permissions would need to sit closer to the consumer of this permission (i.e., the caller).

      Default: - The instance of lambda.IFunction

      Specified by:
      getScope in interface Permission

    • getSourceAccount

      public final String getSourceAccount()
      Description copied from interface: Permission
      The AWS account ID (without hyphens) of the source owner.

      For example, if you specify an S3 bucket in the SourceArn property, this value is the bucket owner's account ID. You can use this property to ensure that all source principals are owned by a specific account.

      Specified by:
      getSourceAccount in interface Permission

    • getSourceArn

      public final String getSourceArn()
      Description copied from interface: Permission
      The ARN of a resource that is invoking your function.

      When granting Amazon Simple Storage Service (Amazon S3) permission to invoke your function, specify this property with the bucket ARN as its value. This ensures that events generated only from the specified bucket, not just any bucket from any AWS account that creates a mapping to your function, can invoke the function.

      Specified by:
      getSourceArn in interface Permission

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object