Class ResourcePolicy


  • public class ResourcePolicy
    extends com.pulumi.resources.CustomResource
    Manages the complete IAM resource-based policy document for an AWS Lambda function, function version, or alias. > **Note:** `PutResourcePolicy` (used by this resource) replaces the *entire* resource-based policy on the Lambda resource, including any statements added with `aws.lambda.Permission`. Do not use `aws.lambda.ResourcePolicy` and `aws.lambda.Permission` on the same Lambda function, version, or alias — every apply of one will overwrite statements managed by the other. ## Example Usage ### Basic Usage
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.AwsFunctions;
     import com.pulumi.aws.inputs.GetCallerIdentityArgs;
     import com.pulumi.aws.iam.IamFunctions;
     import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
     import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementArgs;
     import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementConditionArgs;
     import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementPrincipalArgs;
     import com.pulumi.aws.lambda.ResourcePolicy;
     import com.pulumi.aws.lambda.ResourcePolicyArgs;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             final var current = AwsFunctions.getCallerIdentity(GetCallerIdentityArgs.builder()
                 .build());
     
             final var example = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
                 .statements(GetPolicyDocumentStatementArgs.builder()
                     .conditions(GetPolicyDocumentStatementConditionArgs.builder()
                         .test("StringEquals")
                         .variable("aws:SourceAccount")
                         .values(current.accountId())
                         .build())
                     .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                         .type("Service")
                         .identifiers("s3.amazonaws.com")
                         .build())
                     .sid("AllowInvokeFromS3")
                     .effect("Allow")
                     .actions("lambda:InvokeFunction")
                     .resources(exampleAwsLambdaFunction.arn())
                     .build())
                 .build());
     
             var exampleResourcePolicy = new ResourcePolicy("exampleResourcePolicy", ResourcePolicyArgs.builder()
                 .resourceArn(exampleAwsLambdaFunction.arn())
                 .policy(example.json())
                 .build());
     
         }
     }
     
     
    ### Multiple Principals
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.iam.IamFunctions;
     import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
     import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementArgs;
     import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementPrincipalArgs;
     import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementConditionArgs;
     import com.pulumi.aws.lambda.ResourcePolicy;
     import com.pulumi.aws.lambda.ResourcePolicyArgs;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             final var example = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
                 .statements(            
                     GetPolicyDocumentStatementArgs.builder()
                         .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                             .type("AWS")
                             .identifiers(                        
                                 "123456789012",
                                 "210987654321")
                             .build())
                         .sid("AllowCrossAccountInvoke")
                         .effect("Allow")
                         .actions("lambda:InvokeFunction")
                         .resources(exampleAwsLambdaFunction.arn())
                         .build(),
                     GetPolicyDocumentStatementArgs.builder()
                         .conditions(GetPolicyDocumentStatementConditionArgs.builder()
                             .test("StringEquals")
                             .variable("aws:PrincipalOrgID")
                             .values("o-1234567890")
                             .build())
                         .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                             .type("AWS")
                             .identifiers("*")
                             .build())
                         .sid("AllowOrganizationInvoke")
                         .effect("Allow")
                         .actions("lambda:InvokeFunction")
                         .resources(exampleAwsLambdaFunction.arn())
                         .build())
                 .build());
     
             var exampleResourcePolicy = new ResourcePolicy("exampleResourcePolicy", ResourcePolicyArgs.builder()
                 .resourceArn(exampleAwsLambdaFunction.arn())
                 .policy(example.json())
                 .build());
     
         }
     }
     
     
    ## Import ### Identity Schema #### Required - `resourceArn` (String) ARN of the Lambda function, function version, or function alias. Using `pulumi import`, import Lambda policies using the `resourceArn`. For example: ```sh $ pulumi import aws:lambda/resourcePolicy:ResourcePolicy example arn:aws:lambda:us-east-1:123456789012:function:example ```
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static ResourcePolicy get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ResourcePolicyState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> policy()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> resourceArn()  
      com.pulumi.core.Output<java.lang.String> revisionId()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ResourcePolicy

        public ResourcePolicy​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • ResourcePolicy

        public ResourcePolicy​(java.lang.String name,
                              ResourcePolicyArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • ResourcePolicy

        public ResourcePolicy​(java.lang.String name,
                              ResourcePolicyArgs args,
                              @Nullable
                              com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • policy

        public com.pulumi.core.Output<java.lang.String> policy()
        Returns:
        JSON-formatted resource-based policy document to attach to the Lambda resource. This replaces the entire policy on the resource. Maximum 20,480 characters.
      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
      • resourceArn

        public com.pulumi.core.Output<java.lang.String> resourceArn()
        Returns:
        ARN of the Lambda function, function version, or function alias to attach the policy to. Can be a qualified or unqualified ARN.
      • revisionId

        public com.pulumi.core.Output<java.lang.String> revisionId()
        Returns:
        Unique identifier for the current revision of the policy.
      • get

        public static ResourcePolicy get​(java.lang.String name,
                                         com.pulumi.core.Output<java.lang.String> id,
                                         @Nullable
                                         ResourcePolicyState state,
                                         @Nullable
                                         com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.