Class: Aws::SecurityLake::Types::SubscriberResource

Inherits:

Struct

Object
Struct
Aws::SecurityLake::Types::SubscriberResource

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-securitylake/types.rb

Overview

Provides details about the Amazon Security Lake account subscription. Subscribers are notified of new objects for a source as the data is written to your Amazon S3 bucket for Security Lake.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#access_types ⇒ Array<String>

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.
#created_at ⇒ Time

The date and time when the subscriber was created.
#resource_share_arn ⇒ String

The Amazon Resource Name (ARN) which uniquely defines the Amazon Web Services RAM resource share.
#resource_share_name ⇒ String

The name of the resource share.
#role_arn ⇒ String

The Amazon Resource Name (ARN) specifying the role of the subscriber.
#s3_bucket_arn ⇒ String

The ARN for the Amazon S3 bucket.
#sources ⇒ Array<Types::LogSourceResource>

Amazon Security Lake supports log and event collection for natively supported Amazon Web Services services.
#subscriber_arn ⇒ String

The subscriber ARN of the Amazon Security Lake subscriber account.
#subscriber_description ⇒ String

The subscriber descriptions for a subscriber account.
#subscriber_endpoint ⇒ String

The subscriber endpoint to which exception messages are posted.
#subscriber_id ⇒ String

The subscriber ID of the Amazon Security Lake subscriber account.
#subscriber_identity ⇒ Types::AwsIdentity

The Amazon Web Services identity used to access your data.
#subscriber_name ⇒ String

The name of your Amazon Security Lake subscriber account.
#subscriber_status ⇒ String

The subscriber status of the Amazon Security Lake subscriber account.
#updated_at ⇒ Time

The date and time when the subscriber was last updated.

Instance Attribute Details

#access_types ⇒ `Array<String>`

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.

Subscribers can consume data by directly querying Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as ‘LAKEFORMATION`.

Returns:

(Array<String>)

# File 'lib/aws-sdk-securitylake/types.rb', line 1759

class SubscriberResource < Struct.new(
  :access_types,
  :created_at,
  :resource_share_arn,
  :resource_share_name,
  :role_arn,
  :s3_bucket_arn,
  :sources,
  :subscriber_arn,
  :subscriber_description,
  :subscriber_endpoint,
  :subscriber_id,
  :subscriber_identity,
  :subscriber_name,
  :subscriber_status,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ `Time`

The date and time when the subscriber was created.

Returns:

(Time)

# File 'lib/aws-sdk-securitylake/types.rb', line 1759

class SubscriberResource < Struct.new(
  :access_types,
  :created_at,
  :resource_share_arn,
  :resource_share_name,
  :role_arn,
  :s3_bucket_arn,
  :sources,
  :subscriber_arn,
  :subscriber_description,
  :subscriber_endpoint,
  :subscriber_id,
  :subscriber_identity,
  :subscriber_name,
  :subscriber_status,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#resource_share_arn ⇒ `String`

The Amazon Resource Name (ARN) which uniquely defines the Amazon Web Services RAM resource share. Before accepting the RAM resource share invitation, you can view details related to the RAM resource share.

This field is available only for Lake Formation subscribers created after March 8, 2023.

Returns:

(String)

# File 'lib/aws-sdk-securitylake/types.rb', line 1759

class SubscriberResource < Struct.new(
  :access_types,
  :created_at,
  :resource_share_arn,
  :resource_share_name,
  :role_arn,
  :s3_bucket_arn,
  :sources,
  :subscriber_arn,
  :subscriber_description,
  :subscriber_endpoint,
  :subscriber_id,
  :subscriber_identity,
  :subscriber_name,
  :subscriber_status,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#resource_share_name ⇒ `String`

The name of the resource share.

Returns:

(String)

# File 'lib/aws-sdk-securitylake/types.rb', line 1759

class SubscriberResource < Struct.new(
  :access_types,
  :created_at,
  :resource_share_arn,
  :resource_share_name,
  :role_arn,
  :s3_bucket_arn,
  :sources,
  :subscriber_arn,
  :subscriber_description,
  :subscriber_endpoint,
  :subscriber_id,
  :subscriber_identity,
  :subscriber_name,
  :subscriber_status,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ `String`

The Amazon Resource Name (ARN) specifying the role of the subscriber.

Returns:

(String)

# File 'lib/aws-sdk-securitylake/types.rb', line 1759

class SubscriberResource < Struct.new(
  :access_types,
  :created_at,
  :resource_share_arn,
  :resource_share_name,
  :role_arn,
  :s3_bucket_arn,
  :sources,
  :subscriber_arn,
  :subscriber_description,
  :subscriber_endpoint,
  :subscriber_id,
  :subscriber_identity,
  :subscriber_name,
  :subscriber_status,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#s3_bucket_arn ⇒ `String`

The ARN for the Amazon S3 bucket.

Returns:

(String)

# File 'lib/aws-sdk-securitylake/types.rb', line 1759

class SubscriberResource < Struct.new(
  :access_types,
  :created_at,
  :resource_share_arn,
  :resource_share_name,
  :role_arn,
  :s3_bucket_arn,
  :sources,
  :subscriber_arn,
  :subscriber_description,
  :subscriber_endpoint,
  :subscriber_id,
  :subscriber_identity,
  :subscriber_name,
  :subscriber_status,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#sources ⇒ `Array<Types::LogSourceResource>`

Amazon Security Lake supports log and event collection for natively supported Amazon Web Services services. For more information, see the [Amazon Security Lake User Guide].

[1]: docs.aws.amazon.com/security-lake/latest/userguide/source-management.html

Returns:

(Array<Types::LogSourceResource>)

# File 'lib/aws-sdk-securitylake/types.rb', line 1759

class SubscriberResource < Struct.new(
  :access_types,
  :created_at,
  :resource_share_arn,
  :resource_share_name,
  :role_arn,
  :s3_bucket_arn,
  :sources,
  :subscriber_arn,
  :subscriber_description,
  :subscriber_endpoint,
  :subscriber_id,
  :subscriber_identity,
  :subscriber_name,
  :subscriber_status,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#subscriber_arn ⇒ `String`

The subscriber ARN of the Amazon Security Lake subscriber account.

Returns:

(String)

# File 'lib/aws-sdk-securitylake/types.rb', line 1759

class SubscriberResource < Struct.new(
  :access_types,
  :created_at,
  :resource_share_arn,
  :resource_share_name,
  :role_arn,
  :s3_bucket_arn,
  :sources,
  :subscriber_arn,
  :subscriber_description,
  :subscriber_endpoint,
  :subscriber_id,
  :subscriber_identity,
  :subscriber_name,
  :subscriber_status,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#subscriber_description ⇒ `String`

The subscriber descriptions for a subscriber account. The description for a subscriber includes ‘subscriberName`, `accountID`, `externalID`, and `subscriberId`.

Returns:

(String)

# File 'lib/aws-sdk-securitylake/types.rb', line 1759

class SubscriberResource < Struct.new(
  :access_types,
  :created_at,
  :resource_share_arn,
  :resource_share_name,
  :role_arn,
  :s3_bucket_arn,
  :sources,
  :subscriber_arn,
  :subscriber_description,
  :subscriber_endpoint,
  :subscriber_id,
  :subscriber_identity,
  :subscriber_name,
  :subscriber_status,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#subscriber_endpoint ⇒ `String`

The subscriber endpoint to which exception messages are posted.

Returns:

(String)

# File 'lib/aws-sdk-securitylake/types.rb', line 1759

class SubscriberResource < Struct.new(
  :access_types,
  :created_at,
  :resource_share_arn,
  :resource_share_name,
  :role_arn,
  :s3_bucket_arn,
  :sources,
  :subscriber_arn,
  :subscriber_description,
  :subscriber_endpoint,
  :subscriber_id,
  :subscriber_identity,
  :subscriber_name,
  :subscriber_status,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#subscriber_id ⇒ `String`

The subscriber ID of the Amazon Security Lake subscriber account.

Returns:

(String)

# File 'lib/aws-sdk-securitylake/types.rb', line 1759

class SubscriberResource < Struct.new(
  :access_types,
  :created_at,
  :resource_share_arn,
  :resource_share_name,
  :role_arn,
  :s3_bucket_arn,
  :sources,
  :subscriber_arn,
  :subscriber_description,
  :subscriber_endpoint,
  :subscriber_id,
  :subscriber_identity,
  :subscriber_name,
  :subscriber_status,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#subscriber_identity ⇒ `Types::AwsIdentity`

The Amazon Web Services identity used to access your data.

Returns:

(Types::AwsIdentity)

# File 'lib/aws-sdk-securitylake/types.rb', line 1759

class SubscriberResource < Struct.new(
  :access_types,
  :created_at,
  :resource_share_arn,
  :resource_share_name,
  :role_arn,
  :s3_bucket_arn,
  :sources,
  :subscriber_arn,
  :subscriber_description,
  :subscriber_endpoint,
  :subscriber_id,
  :subscriber_identity,
  :subscriber_name,
  :subscriber_status,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#subscriber_name ⇒ `String`

The name of your Amazon Security Lake subscriber account.

Returns:

(String)

# File 'lib/aws-sdk-securitylake/types.rb', line 1759

class SubscriberResource < Struct.new(
  :access_types,
  :created_at,
  :resource_share_arn,
  :resource_share_name,
  :role_arn,
  :s3_bucket_arn,
  :sources,
  :subscriber_arn,
  :subscriber_description,
  :subscriber_endpoint,
  :subscriber_id,
  :subscriber_identity,
  :subscriber_name,
  :subscriber_status,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#subscriber_status ⇒ `String`

The subscriber status of the Amazon Security Lake subscriber account.

Returns:

(String)

# File 'lib/aws-sdk-securitylake/types.rb', line 1759

class SubscriberResource < Struct.new(
  :access_types,
  :created_at,
  :resource_share_arn,
  :resource_share_name,
  :role_arn,
  :s3_bucket_arn,
  :sources,
  :subscriber_arn,
  :subscriber_description,
  :subscriber_endpoint,
  :subscriber_id,
  :subscriber_identity,
  :subscriber_name,
  :subscriber_status,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ `Time`

The date and time when the subscriber was last updated.

Returns:

(Time)

# File 'lib/aws-sdk-securitylake/types.rb', line 1759

class SubscriberResource < Struct.new(
  :access_types,
  :created_at,
  :resource_share_arn,
  :resource_share_name,
  :role_arn,
  :s3_bucket_arn,
  :sources,
  :subscriber_arn,
  :subscriber_description,
  :subscriber_endpoint,
  :subscriber_id,
  :subscriber_identity,
  :subscriber_name,
  :subscriber_status,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::SecurityLake::Types::SubscriberResource

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#access_types ⇒ Array<String>

#created_at ⇒ Time

#resource_share_arn ⇒ String

#resource_share_name ⇒ String

#role_arn ⇒ String

#s3_bucket_arn ⇒ String

#sources ⇒ Array<Types::LogSourceResource>

#subscriber_arn ⇒ String

#subscriber_description ⇒ String

#subscriber_endpoint ⇒ String

#subscriber_id ⇒ String

#subscriber_identity ⇒ Types::AwsIdentity

#subscriber_name ⇒ String

#subscriber_status ⇒ String

#updated_at ⇒ Time

#access_types ⇒ `Array<String>`

#created_at ⇒ `Time`

#resource_share_arn ⇒ `String`

#resource_share_name ⇒ `String`

#role_arn ⇒ `String`

#s3_bucket_arn ⇒ `String`

#sources ⇒ `Array<Types::LogSourceResource>`

#subscriber_arn ⇒ `String`

#subscriber_description ⇒ `String`

#subscriber_endpoint ⇒ `String`

#subscriber_id ⇒ `String`

#subscriber_identity ⇒ `Types::AwsIdentity`

#subscriber_name ⇒ `String`

#subscriber_status ⇒ `String`

#updated_at ⇒ `Time`