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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#archive_arn ⇒ String

The ARN of the archive.

Returns:

  • (String) 


1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1733

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) 


1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1733

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) 


1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1733

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) 


1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1733

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) 


1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1733

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) 


1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1733

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) 


1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1733

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.

Returns:

  • (String) 


1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1733

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) 


1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1733

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) 


1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1733

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) 


1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1733

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) 


1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1733

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