Package com.pulumi.aws.securitylake

Class Subscriber

  • public class Subscriber
extends com.pulumi.resources.CustomResource
    Resource for managing an AWS Security Lake Subscriber. > **NOTE:** The underlying `aws.securitylake.DataLake` must be configured before creating the `aws.securitylake.Subscriber`. Use a `dependsOn` statement. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.securitylake.Subscriber;
 import com.pulumi.aws.securitylake.SubscriberArgs;
 import com.pulumi.aws.securitylake.inputs.SubscriberSubscriberIdentityArgs;
 import com.pulumi.aws.securitylake.inputs.SubscriberSourceArgs;
 import com.pulumi.aws.securitylake.inputs.SubscriberSourceAwsLogSourceResourceArgs;
 import com.pulumi.resources.CustomResourceOptions;
 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 Subscriber("example", SubscriberArgs.builder()
             .subscriberIdentity(SubscriberSubscriberIdentityArgs.builder()
                 .externalId("example")
                 .principal("1234567890")
                 .build())
             .sources(SubscriberSourceArgs.builder()
                 .awsLogSourceResource(SubscriberSourceAwsLogSourceResourceArgs.builder()
                     .sourceName("ROUTE53")
                     .sourceVersion("1.0")
                     .build())
                 .build())
             .subscriberName("example-name")
             .accessType("S3")
             .build(), CustomResourceOptions.builder()
                 .dependsOn(exampleAwsSecuritylakeDataLake)
                 .build());
 
     }
 }
    ### Multiple Log Sources 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.securitylake.Subscriber;
 import com.pulumi.aws.securitylake.SubscriberArgs;
 import com.pulumi.aws.securitylake.inputs.SubscriberSubscriberIdentityArgs;
 import com.pulumi.aws.securitylake.inputs.SubscriberSourceArgs;
 import com.pulumi.aws.securitylake.inputs.SubscriberSourceAwsLogSourceResourceArgs;
 import com.pulumi.resources.CustomResourceOptions;
 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 Subscriber("example", SubscriberArgs.builder()
             .subscriberIdentity(SubscriberSubscriberIdentityArgs.builder()
                 .externalId("example")
                 .principal("1234567890")
                 .build())
             .sources(            
                 SubscriberSourceArgs.builder()
                     .awsLogSourceResource(SubscriberSourceAwsLogSourceResourceArgs.builder()
                         .sourceName("SH_FINDINGS")
                         .sourceVersion("2.0")
                         .build())
                     .build(),
                 SubscriberSourceArgs.builder()
                     .awsLogSourceResource(SubscriberSourceAwsLogSourceResourceArgs.builder()
                         .sourceName("ROUTE53")
                         .sourceVersion("2.0")
                         .build())
                     .build())
             .subscriberName("example-name")
             .accessType("S3")
             .build(), CustomResourceOptions.builder()
                 .dependsOn(exampleAwsSecuritylakeDataLake)
                 .build());
 
     }
 }
    ## Import Using `pulumi import`, import Security Lake subscriber using the subscriber ID. For example: ```sh $ pulumi import aws:securitylake/subscriber:Subscriber example 9f3bfe79-d543-474d-a93c-f3846805d208 ```

    • 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
      com.pulumi.core.Output<java.lang.String> accessType()  
      com.pulumi.core.Output<java.lang.String> arn()  
      static Subscriber get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, SubscriberState 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> region()  
      com.pulumi.core.Output<java.lang.String> resourceShareArn()  
      com.pulumi.core.Output<java.lang.String> resourceShareName()  
      com.pulumi.core.Output<java.lang.String> roleArn()  
      com.pulumi.core.Output<java.lang.String> s3BucketArn()  
      com.pulumi.core.Output<java.util.List<SubscriberSource>> sources()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> subscriberDescription()  
      com.pulumi.core.Output<java.lang.String> subscriberEndpoint()  
      com.pulumi.core.Output<SubscriberSubscriberIdentity> subscriberIdentity()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> subscriberName()  
      com.pulumi.core.Output<java.lang.String> subscriberStatus()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.util.Optional<SubscriberTimeouts>> timeouts()  

      • 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

      • Subscriber

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

      • Subscriber

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

      • Subscriber

        public Subscriber​(java.lang.String name,
                  SubscriberArgs 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

      • accessType

        public com.pulumi.core.Output<java.lang.String> accessType()
        Returns:
        The Amazon S3 or Lake Formation access type.

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        The ARN of the subscriber.

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

      • resourceShareArn

        public com.pulumi.core.Output<java.lang.String> resourceShareArn()
        Returns:
        ARN which uniquely defines the AWS RAM resource share. Before accepting the RAM resource share invitation, you can view details related to the RAM resource share.

      • resourceShareName

        public com.pulumi.core.Output<java.lang.String> resourceShareName()
        Returns:
        The name of the resource share.

      • roleArn

        public com.pulumi.core.Output<java.lang.String> roleArn()
        Returns:
        The ARN of the IAM role to be used by the entity putting logs into your custom source partition.

      • s3BucketArn

        public com.pulumi.core.Output<java.lang.String> s3BucketArn()
        Returns:
        The ARN for the Amazon Security Lake Amazon S3 bucket.

      • sources

        public com.pulumi.core.Output<java.util.List<SubscriberSource>> sources()
        Returns:
        The supported AWS services from which logs and events are collected. Security Lake supports log and event collection for natively supported AWS services. See `source` Blocks below.

      • subscriberDescription

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> subscriberDescription()
        Returns:
        The description for your subscriber account in Security Lake.

      • subscriberEndpoint

        public com.pulumi.core.Output<java.lang.String> subscriberEndpoint()
        Returns:
        The subscriber endpoint to which exception messages are posted.

      • subscriberIdentity

        public com.pulumi.core.Output<SubscriberSubscriberIdentity> subscriberIdentity()
        Returns:
        The AWS identity used to access your data. See `subscriberIdentity` Block below.

      • subscriberName

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> subscriberName()
        Returns:
        The name of your Security Lake subscriber account.

      • subscriberStatus

        public com.pulumi.core.Output<java.lang.String> subscriberStatus()
        Returns:
        The subscriber status of the Amazon Security Lake subscriber account.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • timeouts

        public com.pulumi.core.Output<java.util.Optional<SubscriberTimeouts>> timeouts()

      • get

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