Package software.amazon.awscdk.services.securitylake

Class CfnSubscriber

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.securitylake.CfnSubscriber
All Implemented Interfaces:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:34:09.804Z") @Stability(Stable) public class CfnSubscriber extends CfnResource implements IInspectable, ITaggableV2
Creates a subscriber for accounts that are already enabled in Amazon Security Lake.

You can create a subscriber with access to data in the current AWS Region.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.securitylake.*;
 CfnSubscriber cfnSubscriber = CfnSubscriber.Builder.create(this, "MyCfnSubscriber")
         .accessTypes(List.of("accessTypes"))
         .dataLakeArn("dataLakeArn")
         .subscriberIdentity(SubscriberIdentityProperty.builder()
                 .externalId("externalId")
                 .principal("principal")
                 .build())
         .subscriberName("subscriberName")
         // the properties below are optional
         .subscriberDescription("subscriberDescription")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSubscriber

      protected CfnSubscriber(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnSubscriber

      protected CfnSubscriber(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnSubscriber

      @Stability(Stable) public CfnSubscriber(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnSubscriberProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrResourceShareArn

      @Stability(Stable) @NotNull public String getAttrResourceShareArn()
      The Amazon Resource Name (ARN) of the Amazon Security Lake subscriber.

    • getAttrResourceShareName

      @Stability(Stable) @NotNull public String getAttrResourceShareName()
      The ARN name of the Amazon Security Lake subscriber.

    • getAttrS3BucketArn

      @Stability(Stable) @NotNull public String getAttrS3BucketArn()
      The Amazon Resource Name (ARN) of the S3 bucket.

    • getAttrSubscriberArn

      @Stability(Stable) @NotNull public String getAttrSubscriberArn()
      The Amazon Resource Name (ARN) of the Security Lake subscriber.

    • getAttrSubscriberRoleArn

      @Stability(Stable) @NotNull public String getAttrSubscriberRoleArn()
      The Amazon Resource Name (ARN) of the role used to create the Security Lake subscriber.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getAccessTypes

      @Stability(Stable) @NotNull public List<String> getAccessTypes()
      You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.

    • setAccessTypes

      @Stability(Stable) public void setAccessTypes(@NotNull List<String> value)
      You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.

    • getDataLakeArn

      @Stability(Stable) @NotNull public String getDataLakeArn()
      The Amazon Resource Name (ARN) used to create the data lake.

    • setDataLakeArn

      @Stability(Stable) public void setDataLakeArn(@NotNull String value)
      The Amazon Resource Name (ARN) used to create the data lake.

    • getSubscriberIdentity

      @Stability(Stable) @NotNull public Object getSubscriberIdentity()
      The AWS identity used to access your data.

    • setSubscriberIdentity

      @Stability(Stable) public void setSubscriberIdentity(@NotNull IResolvable value)
      The AWS identity used to access your data.

    • setSubscriberIdentity

      @Stability(Stable) public void setSubscriberIdentity(@NotNull CfnSubscriber.SubscriberIdentityProperty value)
      The AWS identity used to access your data.

    • getSubscriberName

      @Stability(Stable) @NotNull public String getSubscriberName()
      The name of your Amazon Security Lake subscriber account.

    • setSubscriberName

      @Stability(Stable) public void setSubscriberName(@NotNull String value)
      The name of your Amazon Security Lake subscriber account.

    • getSubscriberDescription

      @Stability(Stable) @Nullable public String getSubscriberDescription()
      The subscriber descriptions for a subscriber account.

    • setSubscriberDescription

      @Stability(Stable) public void setSubscriberDescription(@Nullable String value)
      The subscriber descriptions for a subscriber account.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of objects, one for each tag to associate with the subscriber.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of objects, one for each tag to associate with the subscriber.