Package com.pulumi.aws.sqs

Class QueuePolicy

  • public class QueuePolicy
extends com.pulumi.resources.CustomResource
    Allows you to set a policy of an SQS Queue while referencing ARN of the queue within the policy. ## Example Usage <!--Start PulumiCodeChooser --> ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.sqs.Queue; import com.pulumi.aws.sqs.QueueArgs; import com.pulumi.aws.iam.IamFunctions; import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs; import com.pulumi.aws.sqs.QueuePolicy; import com.pulumi.aws.sqs.QueuePolicyArgs; import java.util.List; import java.util.ArrayList; 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) { var q = new Queue("q", QueueArgs.builder() .name("examplequeue") .build()); final var test = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder() .statements(GetPolicyDocumentStatementArgs.builder() .sid("First") .effect("Allow") .principals(GetPolicyDocumentStatementPrincipalArgs.builder() .type("*") .identifiers("*") .build()) .actions("sqs:SendMessage") .resources(q.arn()) .conditions(GetPolicyDocumentStatementConditionArgs.builder() .test("ArnEquals") .variable("aws:SourceArn") .values(example.arn()) .build()) .build()) .build()); var testQueuePolicy = new QueuePolicy("testQueuePolicy", QueuePolicyArgs.builder() .queueUrl(q.id()) .policy(test.applyValue(getPolicyDocumentResult -> getPolicyDocumentResult).applyValue(test -> test.applyValue(getPolicyDocumentResult -> getPolicyDocumentResult.json()))) .build()); } } ``` <!--End PulumiCodeChooser --> ## Import Using `pulumi import`, import SQS Queue Policies using the queue URL. For example: ```sh $ pulumi import aws:sqs/queuePolicy:QueuePolicy test https://queue.amazonaws.com/0123456789012/myqueue ```

    • 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 QueuePolicy get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, QueuePolicyState 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> queueUrl()  

      • 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

      • QueuePolicy

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

      • QueuePolicy

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

      • QueuePolicy

        public QueuePolicy​(java.lang.String name,
                   QueuePolicyArgs 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:
        The JSON policy for the SQS queue.

      • queueUrl

        public com.pulumi.core.Output<java.lang.String> queueUrl()
        Returns:
        The URL of the SQS Queue to which to attach the policy

      • get

        public static QueuePolicy get​(java.lang.String name,
                              com.pulumi.core.Output<java.lang.String> id,
                              @Nullable
                              QueuePolicyState 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.