Package com.pulumi.aws.kinesis

Class ResourcePolicy

  • public class ResourcePolicy
extends com.pulumi.resources.CustomResource
    Provides a resource to manage an Amazon Kinesis Streams resource policy. Use a resource policy to manage cross-account access to your data streams or consumers. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.kinesis.ResourcePolicy;
 import com.pulumi.aws.kinesis.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) {
         var example = new ResourcePolicy("example", ResourcePolicyArgs.builder()
             .resourceArn(exampleAwsKinesisStream.arn())
             .policy("""
 {
   \"Version\": \"2012-10-17\",
   \"Id\": \"writePolicy\",
   \"Statement\": [{
     \"Sid\": \"writestatement\",
     \"Effect\": \"Allow\",
     \"Principal\": {
       \"AWS\": \"123456789456\"
     },
     \"Action\": [
       \"kinesis:DescribeStreamSummary\",
       \"kinesis:ListShards\",
       \"kinesis:PutRecord\",
       \"kinesis:PutRecords\"
     ],
     \"Resource\": \"%s\"
   }]
 }
 ", exampleAwsKinesisStream.arn()))
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required - `resourceArn` (String) ARN of the Kinesis stream. Using `pulumi import`, import Kinesis resource policies using the `resourceArn`. For example: ```sh $ pulumi import aws:kinesis/resourcePolicy:ResourcePolicy example arn:aws:kinesis:us-west-2:123456789012:stream/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()  

      • 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:
        Policy document.

      • 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 data stream or consumer.

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