Class: Aws::EventBridge::Types::DescribeArchiveResponse

Inherits:

Struct

• Object
• Struct
• Aws::EventBridge::Types::DescribeArchiveResponse

Includes:

Structure

Defined in:

lib/aws-sdk-eventbridge/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #archive_arn ⇒ String

  The ARN of the archive.

• #archive_name ⇒ String

  The name of the archive.

• #creation_time ⇒ Time

  The time at which the archive was created.

• #description ⇒ String

  The description of the archive.

• #event_count ⇒ Integer

  The number of events in the archive.

• #event_pattern ⇒ String

  The event pattern used to filter events sent to the archive.

• #event_source_arn ⇒ String

  The ARN of the event source associated with the archive.

• #kms_key_identifier ⇒ String

  The identifier of the KMS customer managed key for EventBridge to use to encrypt this archive, if one has been specified.

• #retention_days ⇒ Integer

  The number of days to retain events for in the archive.

• #size_bytes ⇒ Integer

  The size of the archive in bytes.

• #state ⇒ String

  The state of the archive.

• #state_reason ⇒ String

  The reason that the archive is in the state.

Instance Attribute Details

#archive_arn ⇒ String

The ARN of the archive.

Returns:

• (String)

# File 'lib/aws-sdk-eventbridge/types.rb', line 1687

class DescribeArchiveResponse < Struct.new(
  :archive_arn,
  :archive_name,
  :event_source_arn,
  :description,
  :event_pattern,
  :state,
  :state_reason,
  :kms_key_identifier,
  :retention_days,
  :size_bytes,
  :event_count,
  :creation_time)
  SENSITIVE = []
  include Aws::Structure
end

#archive_name ⇒ String

The name of the archive.

Returns:

• (String)

# File 'lib/aws-sdk-eventbridge/types.rb', line 1687

class DescribeArchiveResponse < Struct.new(
  :archive_arn,
  :archive_name,
  :event_source_arn,
  :description,
  :event_pattern,
  :state,
  :state_reason,
  :kms_key_identifier,
  :retention_days,
  :size_bytes,
  :event_count,
  :creation_time)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

The time at which the archive was created.

Returns:

• (Time)

# File 'lib/aws-sdk-eventbridge/types.rb', line 1687

class DescribeArchiveResponse < Struct.new(
  :archive_arn,
  :archive_name,
  :event_source_arn,
  :description,
  :event_pattern,
  :state,
  :state_reason,
  :kms_key_identifier,
  :retention_days,
  :size_bytes,
  :event_count,
  :creation_time)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the archive.

Returns:

• (String)

# File 'lib/aws-sdk-eventbridge/types.rb', line 1687

class DescribeArchiveResponse < Struct.new(
  :archive_arn,
  :archive_name,
  :event_source_arn,
  :description,
  :event_pattern,
  :state,
  :state_reason,
  :kms_key_identifier,
  :retention_days,
  :size_bytes,
  :event_count,
  :creation_time)
  SENSITIVE = []
  include Aws::Structure
end

#event_count ⇒ Integer

The number of events in the archive.

Returns:

• (Integer)

# File 'lib/aws-sdk-eventbridge/types.rb', line 1687

class DescribeArchiveResponse < Struct.new(
  :archive_arn,
  :archive_name,
  :event_source_arn,
  :description,
  :event_pattern,
  :state,
  :state_reason,
  :kms_key_identifier,
  :retention_days,
  :size_bytes,
  :event_count,
  :creation_time)
  SENSITIVE = []
  include Aws::Structure
end

#event_pattern ⇒ String

The event pattern used to filter events sent to the archive.

Returns:

• (String)

# File 'lib/aws-sdk-eventbridge/types.rb', line 1687

class DescribeArchiveResponse < Struct.new(
  :archive_arn,
  :archive_name,
  :event_source_arn,
  :description,
  :event_pattern,
  :state,
  :state_reason,
  :kms_key_identifier,
  :retention_days,
  :size_bytes,
  :event_count,
  :creation_time)
  SENSITIVE = []
  include Aws::Structure
end

#event_source_arn ⇒ String

The ARN of the event source associated with the archive.

Returns:

• (String)

# File 'lib/aws-sdk-eventbridge/types.rb', line 1687

class DescribeArchiveResponse < Struct.new(
  :archive_arn,
  :archive_name,
  :event_source_arn,
  :description,
  :event_pattern,
  :state,
  :state_reason,
  :kms_key_identifier,
  :retention_days,
  :size_bytes,
  :event_count,
  :creation_time)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_identifier ⇒ String

The identifier of the KMS customer managed key for EventBridge to use to encrypt this archive, if one has been specified.

For more information, see [Encrypting archives] in the *Amazon EventBridge User Guide*.

[1]: docs.aws.amazon.com/eventbridge/latest/userguide/encryption-archives.html

Returns:

• (String)

# File 'lib/aws-sdk-eventbridge/types.rb', line 1687

class DescribeArchiveResponse < Struct.new(
  :archive_arn,
  :archive_name,
  :event_source_arn,
  :description,
  :event_pattern,
  :state,
  :state_reason,
  :kms_key_identifier,
  :retention_days,
  :size_bytes,
  :event_count,
  :creation_time)
  SENSITIVE = []
  include Aws::Structure
end

#retention_days ⇒ Integer

The number of days to retain events for in the archive.

Returns:

• (Integer)

# File 'lib/aws-sdk-eventbridge/types.rb', line 1687

class DescribeArchiveResponse < Struct.new(
  :archive_arn,
  :archive_name,
  :event_source_arn,
  :description,
  :event_pattern,
  :state,
  :state_reason,
  :kms_key_identifier,
  :retention_days,
  :size_bytes,
  :event_count,
  :creation_time)
  SENSITIVE = []
  include Aws::Structure
end

#size_bytes ⇒ Integer

The size of the archive in bytes.

Returns:

• (Integer)

# File 'lib/aws-sdk-eventbridge/types.rb', line 1687

class DescribeArchiveResponse < Struct.new(
  :archive_arn,
  :archive_name,
  :event_source_arn,
  :description,
  :event_pattern,
  :state,
  :state_reason,
  :kms_key_identifier,
  :retention_days,
  :size_bytes,
  :event_count,
  :creation_time)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The state of the archive.

Returns:

• (String)

# File 'lib/aws-sdk-eventbridge/types.rb', line 1687

class DescribeArchiveResponse < Struct.new(
  :archive_arn,
  :archive_name,
  :event_source_arn,
  :description,
  :event_pattern,
  :state,
  :state_reason,
  :kms_key_identifier,
  :retention_days,
  :size_bytes,
  :event_count,
  :creation_time)
  SENSITIVE = []
  include Aws::Structure
end

#state_reason ⇒ String

The reason that the archive is in the state.

Returns:

• (String)

# File 'lib/aws-sdk-eventbridge/types.rb', line 1687

class DescribeArchiveResponse < Struct.new(
  :archive_arn,
  :archive_name,
  :event_source_arn,
  :description,
  :event_pattern,
  :state,
  :state_reason,
  :kms_key_identifier,
  :retention_days,
  :size_bytes,
  :event_count,
  :creation_time)
  SENSITIVE = []
  include Aws::Structure
end