Class: MintPress::Aws::CloudTrail::Trail
- Inherits:
-
Object
- Object
- MintPress::Aws::CloudTrail::Trail
- Includes:
- MintLogger, AwsCommon, Mixins::Properties
- Defined in:
- src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_trail/trail.rb
Properties (Read/Write)
-
#name ⇒ [String]
'Specifies the name of the trail or trail ARN. If Name is a trail name, the string must meet the following requirements: Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) Start with a letter or number, and end with a letter or number Be between 3 and 128 characters Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid. Not be in IP address format (for example, 192.168.5.4) If Name is a trail ARN, it must be in the format: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail'
Property Attributes- create_trail_prop ⇒ 'name'
- read_only ⇒ false
- source ⇒ "update_trail"
- delete_trail_prop ⇒ 'name'
- orig_name ⇒ 'name'
- get_trail_prop ⇒ 'name'
- update_trail_prop ⇒ 'name'
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_trail/trail.rb', line 28 property :name, create_trail_prop: 'name', type: [String], read_only: false, source: "update_trail", description: 'Specifies the name of the trail or trail ARN. If Name is a trail name, the string must meet the following requirements: Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) Start with a letter or number, and end with a letter or number Be between 3 and 128 characters Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid. Not be in IP address format (for example, 192.168.5.4) If Name is a trail ARN, it must be in the format: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail', delete_trail_prop: 'name', orig_name: 'name', get_trail_prop: 'name', update_trail_prop: 'name'
-
#s3_bucket_name ⇒ [String]
'Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.'
Property Attributes- create_trail_prop ⇒ 's3_bucket_name'
- read_only ⇒ false
- source ⇒ "update_trail"
- orig_name ⇒ 's3_bucket_name'
- update_trail_prop ⇒ 's3_bucket_name'
45 46
# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_trail/trail.rb', line 45 property :s3_bucket_name, create_trail_prop: 's3_bucket_name', type: [String], read_only: false, source: "update_trail", description: 'Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.', orig_name: 's3_bucket_name', update_trail_prop: 's3_bucket_name'
-
#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. The maximum length is 200 characters.'
Property Attributes- create_trail_prop ⇒ 's3_key_prefix'
- read_only ⇒ false
- source ⇒ "update_trail"
- orig_name ⇒ 's3_key_prefix'
- update_trail_prop ⇒ 's3_key_prefix'
47 48 49 50
# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_trail/trail.rb', line 47 property :s3_key_prefix, create_trail_prop: 's3_key_prefix', type: [String], read_only: false, source: "update_trail", description: '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. The maximum length is 200 characters.', orig_name: 's3_key_prefix', update_trail_prop: 's3_key_prefix'
-
#sns_topic_name ⇒ [String]
'Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.'
Property Attributes- create_trail_prop ⇒ 'sns_topic_name'
- read_only ⇒ false
- source ⇒ "update_trail"
- orig_name ⇒ 'sns_topic_name'
- update_trail_prop ⇒ 'sns_topic_name'
51 52
# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_trail/trail.rb', line 51 property :sns_topic_name, create_trail_prop: 'sns_topic_name', type: [String], read_only: false, source: "update_trail", description: 'Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.', orig_name: 'sns_topic_name', update_trail_prop: 'sns_topic_name'
-
#include_global_service_events ⇒ [TrueClass,FalseClass]
'Specifies whether the trail is publishing events from global services such as IAM to the log files.'
Property Attributes- create_trail_prop ⇒ 'include_global_service_events'
- read_only ⇒ false
- source ⇒ "update_trail"
- orig_name ⇒ 'include_global_service_events'
- update_trail_prop ⇒ 'include_global_service_events'
53 54
# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_trail/trail.rb', line 53 property :include_global_service_events, create_trail_prop: 'include_global_service_events', type: [TrueClass,FalseClass], read_only: false, source: "update_trail", description: 'Specifies whether the trail is publishing events from global services such as IAM to the log files.', orig_name: 'include_global_service_events', update_trail_prop: 'include_global_service_events'
-
#is_multi_region_trail ⇒ [TrueClass,FalseClass]
'Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails that log events in all regions.'
Property Attributes- create_trail_prop ⇒ 'is_multi_region_trail'
- read_only ⇒ false
- source ⇒ "update_trail"
- orig_name ⇒ 'is_multi_region_trail'
- update_trail_prop ⇒ 'is_multi_region_trail'
55 56 57 58 59 60 61 62
# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_trail/trail.rb', line 55 property :is_multi_region_trail, create_trail_prop: 'is_multi_region_trail', type: [TrueClass,FalseClass], read_only: false, source: "update_trail", description: 'Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails that log events in all regions.', orig_name: 'is_multi_region_trail', update_trail_prop: 'is_multi_region_trail'
-
#enable_log_file_validation ⇒ [TrueClass,FalseClass]
'Specifies whether log file validation is enabled. The default is false. When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.'
Property Attributes- create_trail_prop ⇒ 'enable_log_file_validation'
- read_only ⇒ false
- source ⇒ "update_trail"
- update_trail_prop ⇒ 'enable_log_file_validation'
63 64 65 66 67 68 69 70 71 72 73 74
# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_trail/trail.rb', line 63 property :enable_log_file_validation, create_trail_prop: 'enable_log_file_validation', type: [TrueClass,FalseClass], read_only: false, source: "update_trail", description: 'Specifies whether log file validation is enabled. The default is false. When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.', update_trail_prop: 'enable_log_file_validation'
-
#cloud_watch_logs_log_group_arn ⇒ [String]
'Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.'
Property Attributes- create_trail_prop ⇒ 'cloud_watch_logs_log_group_arn'
- read_only ⇒ false
- source ⇒ "update_trail"
- orig_name ⇒ 'cloud_watch_logs_log_group_arn'
- update_trail_prop ⇒ 'cloud_watch_logs_log_group_arn'
75 76 77 78
# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_trail/trail.rb', line 75 property :cloud_watch_logs_log_group_arn, create_trail_prop: 'cloud_watch_logs_log_group_arn', type: [String], read_only: false, source: "update_trail", description: 'Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.', orig_name: 'cloud_watch_logs_log_group_arn', update_trail_prop: 'cloud_watch_logs_log_group_arn'
-
#cloud_watch_logs_role_arn ⇒ [String]
'Specifies the role for the CloudWatch Logs endpoint to assume to write to a user"s log group.'
Property Attributes- create_trail_prop ⇒ 'cloud_watch_logs_role_arn'
- read_only ⇒ false
- source ⇒ "update_trail"
- orig_name ⇒ 'cloud_watch_logs_role_arn'
- update_trail_prop ⇒ 'cloud_watch_logs_role_arn'
79 80
# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_trail/trail.rb', line 79 property :cloud_watch_logs_role_arn, create_trail_prop: 'cloud_watch_logs_role_arn', type: [String], read_only: false, source: "update_trail", description: 'Specifies the role for the CloudWatch Logs endpoint to assume to write to a user"s log group.', orig_name: 'cloud_watch_logs_role_arn', update_trail_prop: 'cloud_watch_logs_role_arn'
-
#is_organization_trail ⇒ [TrueClass,FalseClass]
'Specifies whether the trail is applied to all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations. If the trail is not an organization trail and this is set to true, the trail will be created in all AWS accounts that belong to the organization. If the trail is an organization trail and this is set to false, the trail will remain in the current AWS account but be deleted from all member accounts in the organization.'
Property Attributes- create_trail_prop ⇒ 'is_organization_trail'
- read_only ⇒ false
- source ⇒ "update_trail"
- orig_name ⇒ 'is_organization_trail'
- update_trail_prop ⇒ 'is_organization_trail'
81 82 83 84 85 86 87 88 89 90
# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_trail/trail.rb', line 81 property :is_organization_trail, create_trail_prop: 'is_organization_trail', type: [TrueClass,FalseClass], read_only: false, source: "update_trail", description: 'Specifies whether the trail is applied to all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations. If the trail is not an organization trail and this is set to true, the trail will be created in all AWS accounts that belong to the organization. If the trail is an organization trail and this is set to false, the trail will remain in the current AWS account but be deleted from all member accounts in the organization.', orig_name: 'is_organization_trail', update_trail_prop: 'is_organization_trail'
-
#tags_list ⇒ Hash of ⇒ [MintPress::Aws::CloudTrail::Tag]
'A list of tags.'
Property Attributes- create_trail_prop ⇒ 'tags_list'
- read_only ⇒ false
- source ⇒ "create_trail"
91
# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_trail/trail.rb', line 91 property :tags_list, create_trail_prop: 'tags_list', type: [MintPress::Aws::CloudTrail::Tag], array: false, read_only: false, source: "create_trail", description: 'A list of tags.', hash: true
-
#has_custom_event_selectors ⇒ [TrueClass,FalseClass]
'Specifies if the trail has custom event selectors.'
Property Attributes- disposition ⇒ :attribute
- source ⇒ "MintPress::Aws::CloudTrail::Trail"
- orig_name ⇒ 'has_custom_event_selectors'
92
# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_trail/trail.rb', line 92 property :has_custom_event_selectors, disposition: :attribute, description: 'Specifies if the trail has custom event selectors.', source: "MintPress::Aws::CloudTrail::Trail", orig_name: 'has_custom_event_selectors', type: [TrueClass,FalseClass]
-
#has_insight_selectors ⇒ [TrueClass,FalseClass]
'Specifies whether a trail has insight types specified in an InsightSelector list.'
Property Attributes- disposition ⇒ :attribute
- source ⇒ "MintPress::Aws::CloudTrail::Trail"
- orig_name ⇒ 'has_insight_selectors'
93
# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_trail/trail.rb', line 93 property :has_insight_selectors, disposition: :attribute, description: 'Specifies whether a trail has insight types specified in an InsightSelector list.', source: "MintPress::Aws::CloudTrail::Trail", orig_name: 'has_insight_selectors', type: [TrueClass,FalseClass]
-
#home_region ⇒ [String]
'The region in which the trail was created.'
Property Attributes- disposition ⇒ :attribute
- source ⇒ "MintPress::Aws::CloudTrail::Trail"
- orig_name ⇒ 'home_region'
94
# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_trail/trail.rb', line 94 property :home_region, disposition: :attribute, description: 'The region in which the trail was created.', source: "MintPress::Aws::CloudTrail::Trail", orig_name: 'home_region', type: [String]
-
#log_file_validation_enabled ⇒ [TrueClass,FalseClass]
'Specifies whether log file validation is enabled.'
Property Attributes- disposition ⇒ :attribute
- source ⇒ "MintPress::Aws::CloudTrail::Trail"
- orig_name ⇒ 'log_file_validation_enabled'
95
# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_trail/trail.rb', line 95 property :log_file_validation_enabled, disposition: :attribute, description: 'Specifies whether log file validation is enabled.', source: "MintPress::Aws::CloudTrail::Trail", orig_name: 'log_file_validation_enabled', type: [TrueClass,FalseClass]
-
#sns_topic_arn ⇒ [String]
'Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered.'
Property Attributes- disposition ⇒ :attribute
- source ⇒ "MintPress::Aws::CloudTrail::Trail"
- orig_name ⇒ 'sns_topic_arn'
96
# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_trail/trail.rb', line 96 property :sns_topic_arn, disposition: :attribute, description: 'Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered.', source: "MintPress::Aws::CloudTrail::Trail", orig_name: 'sns_topic_arn', type: [String]
-
#trail_arn ⇒ [String]
'Specifies the ARN of the trail.'
Property Attributes- disposition ⇒ :attribute
- source ⇒ "MintPress::Aws::CloudTrail::Trail"
- orig_name ⇒ 'trail_arn'
97
# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_trail/trail.rb', line 97 property :trail_arn, disposition: :attribute, description: 'Specifies the ARN of the trail.', source: "MintPress::Aws::CloudTrail::Trail", orig_name: 'trail_arn', type: [String]
-
#trail_name_list ⇒ Array of ⇒ [String]
'Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail If an empty list is specified, information for the trail in the current region is returned. If an empty list is specified and IncludeShadowTrails is false, then information for all trails in the current region is returned. If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current region and any associated shadow trails in other regions is returned. If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current region. To return information about a trail in another region, you must specify its trail ARN.'
Property Attributes- describe_trails_prop ⇒ 'trail_name_list'
- source ⇒ "describe_trails"
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_trail/trail.rb', line 98 property :trail_name_list, describe_trails_prop: 'trail_name_list', type: [String], array: true, source: "describe_trails", description: 'Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail If an empty list is specified, information for the trail in the current region is returned. If an empty list is specified and IncludeShadowTrails is false, then information for all trails in the current region is returned. If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current region and any associated shadow trails in other regions is returned. If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current region. To return information about a trail in another region, you must specify its trail ARN.'
-
#include_shadow_trails ⇒ [TrueClass,FalseClass]
'Specifies whether to include shadow trails in the response. A shadow trail is the replication in a region of a trail that was created in a different region, or in the case of an organization trail, the replication of an organization trail in member accounts. If you do not include shadow trails, organization trails in a member account and region replication trails will not be returned. The default is true.'
Property Attributes- describe_trails_prop ⇒ 'include_shadow_trails'
- source ⇒ "describe_trails"
119 120 121 122 123 124
# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_trail/trail.rb', line 119 property :include_shadow_trails, describe_trails_prop: 'include_shadow_trails', type: [TrueClass,FalseClass], source: "describe_trails", description: 'Specifies whether to include shadow trails in the response. A shadow trail is the replication in a region of a trail that was created in a different region, or in the case of an organization trail, the replication of an organization trail in member accounts. If you do not include shadow trails, organization trails in a member account and region replication trails will not be returned. The default is true.'
-
#kms_key ⇒ [String]
'Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier. Examples: alias/MyAliasName arn:aws:kms:us-east-2:123456789012:alias/MyAliasName arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 12345678-1234-1234-1234-123456789012'
Property Attributes- create_trail_prop ⇒ 'kms_key_id'
- read_only ⇒ false
- source ⇒ "update_trail"
- orig_name ⇒ 'kms_key_id'
- update_trail_prop ⇒ 'kms_key_id'
125 126 127 128 129 130 131 132 133 134 135 136
# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_trail/trail.rb', line 125 property :kms_key, create_trail_prop: 'kms_key_id', type: [String], read_only: false, source: "update_trail", description: 'Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier. Examples: alias/MyAliasName arn:aws:kms:us-east-2:123456789012:alias/MyAliasName arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012 12345678-1234-1234-1234-123456789012', orig_name: 'kms_key_id', update_trail_prop: 'kms_key_id'
-
#region ⇒ String
Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
Property Attributes140
# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_trail/trail.rb', line 140 property :region, type: String
-
#platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
Property Attributes- default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
143
# File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_trail/trail.rb', line 143 property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new
Properties (Read Only)
Constant Summary
Constants included from MintLogger
MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN
Instance Attribute Summary
Attributes included from Mixins::Properties
#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root
Instance Method Summary collapse
- #create ⇒ Object
- #delete ⇒ Object
- #delete_cascade ⇒ Object
- #describe ⇒ Object
- #get ⇒ Object
-
#initialize(opts = {}) ⇒ Trail
constructor
A new instance of Trail.
- #list ⇒ Object
- #update ⇒ Object
Methods included from AwsCommon
#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic
Methods included from Mixins::Properties
#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref
Methods included from MintLogger::Utils::Common
#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send