Class: Aws::CloudTrail::Types::CreateTrailResponse

Inherits:

Struct

• Object
• Struct
• Aws::CloudTrail::Types::CreateTrailResponse

Defined in:

gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb

Overview

Returns the objects or data listed below if successful. Otherwise, returns an error.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cloud_watch_logs_log_group_arn ⇒ String

  Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.

• #cloud_watch_logs_role_arn ⇒ String

  Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

• #include_global_service_events ⇒ Boolean

  Specifies whether the trail is publishing events from global services such as IAM to the log files.

• #is_multi_region_trail ⇒ Boolean

  Specifies whether the trail exists in one Region or in all Regions.

• #is_organization_trail ⇒ Boolean

  Specifies whether the trail is an organization trail.

• #kms_key_id ⇒ String

  Specifies the KMS key ID that encrypts the events delivered by CloudTrail.

• #log_file_validation_enabled ⇒ Boolean

  Specifies whether log file integrity validation is enabled.

• #name ⇒ String

  Specifies the name of the trail.

• #s3_bucket_name ⇒ String

  Specifies the name of the Amazon S3 bucket designated for publishing log files.

• #s3_key_prefix ⇒ String

  Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery.

• #sns_topic_arn ⇒ String

  Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered.

• #sns_topic_name ⇒ String

  This field is no longer in use.

• #trail_arn ⇒ String

  Specifies the ARN of the trail that was created.

Instance Attribute Details

#cloud_watch_logs_log_group_arn ⇒ String

Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.

Returns:

• (String)

# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1544

class CreateTrailResponse < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :is_organization_trail)
  SENSITIVE = []
  include Aws::Structure
end

#cloud_watch_logs_role_arn ⇒ String

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

Returns:

• (String)

# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1544

class CreateTrailResponse < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :is_organization_trail)
  SENSITIVE = []
  include Aws::Structure
end

#include_global_service_events ⇒ Boolean

Specifies whether the trail is publishing events from global services such as IAM to the log files.

Returns:

• (Boolean)

# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1544

class CreateTrailResponse < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :is_organization_trail)
  SENSITIVE = []
  include Aws::Structure
end

#is_multi_region_trail ⇒ Boolean

Specifies whether the trail exists in one Region or in all Regions.

Returns:

• (Boolean)

# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1544

class CreateTrailResponse < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :is_organization_trail)
  SENSITIVE = []
  include Aws::Structure
end

#is_organization_trail ⇒ Boolean

Specifies whether the trail is an organization trail.

Returns:

• (Boolean)

# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1544

class CreateTrailResponse < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :is_organization_trail)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.

arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012

Returns:

• (String)

# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1544

class CreateTrailResponse < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :is_organization_trail)
  SENSITIVE = []
  include Aws::Structure
end

#log_file_validation_enabled ⇒ Boolean

Specifies whether log file integrity validation is enabled.

Returns:

• (Boolean)

# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1544

class CreateTrailResponse < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :is_organization_trail)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

Specifies the name of the trail.

Returns:

• (String)

# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1544

class CreateTrailResponse < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :is_organization_trail)
  SENSITIVE = []
  include Aws::Structure
end

#s3_bucket_name ⇒ String

Specifies the name of the Amazon S3 bucket designated for publishing log files.

Returns:

• (String)

# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1544

class CreateTrailResponse < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :is_organization_trail)
  SENSITIVE = []
  include Aws::Structure
end

#s3_key_prefix ⇒ String

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.

Returns:

• (String)

# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1544

class CreateTrailResponse < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :is_organization_trail)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topic_arn ⇒ String

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:

arn:aws:sns:us-east-2:123456789012:MyTopic

Returns:

• (String)

# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1544

class CreateTrailResponse < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :is_organization_trail)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topic_name ⇒ String

This field is no longer in use. Use SnsTopicARN.

Returns:

• (String)

# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1544

class CreateTrailResponse < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :is_organization_trail)
  SENSITIVE = []
  include Aws::Structure
end

#trail_arn ⇒ String

Specifies the ARN of the trail that was created. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

Returns:

• (String)

# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 1544

class CreateTrailResponse < Struct.new(
  :name,
  :s3_bucket_name,
  :s3_key_prefix,
  :sns_topic_name,
  :sns_topic_arn,
  :include_global_service_events,
  :is_multi_region_trail,
  :trail_arn,
  :log_file_validation_enabled,
  :cloud_watch_logs_log_group_arn,
  :cloud_watch_logs_role_arn,
  :kms_key_id,
  :is_organization_trail)
  SENSITIVE = []
  include Aws::Structure
end