Class: AWSCDK::CloudTrail::CfnTrail

Inherits:
AWSCDK::CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSCloudtrail::ITrailRef
Defined in:
cloud_trail/cfn_trail.rb

Overview

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnTrail

Create a new AWS::CloudTrail::Trail.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::CloudTrail::CfnTrailProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'cloud_trail/cfn_trail.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudTrail::CfnTrailProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR0cmFpbC5DZm5UcmFpbFByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_trail(resource) ⇒ String

Parameters:

Returns:

  • (String) 


89
90
91
92
 
# File 'cloud_trail/cfn_trail.rb', line 89

def self.arn_for_trail(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jbG91ZHRyYWlsLklUcmFpbFJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudtrail.CfnTrail", "arnForTrail", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


222
223
224
 
# File 'cloud_trail/cfn_trail.rb', line 222

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cloudtrail.CfnTrail", "CFN_RESOURCE_TYPE_NAME")
end

.from_trail_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSCloudtrail::ITrailRef

Creates a new ITrailRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



100
101
102
103
104
105
 
# File 'cloud_trail/cfn_trail.rb', line 100

def self.from_trail_arn(scope, id, arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudtrail.CfnTrail", "fromTrailArn", [scope, id, arn])
end

.from_trail_name(scope, id, trail_name) ⇒ AWSCDK::Interfaces::AWSCloudtrail::ITrailRef

Creates a new ITrailRef from a trailName.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • trail_name (String)

Returns:



113
114
115
116
117
118
 
# File 'cloud_trail/cfn_trail.rb', line 113

def self.from_trail_name(scope, id, trail_name)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(trail_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "trailName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudtrail.CfnTrail", "fromTrailName", [scope, id, trail_name])
end

.is_cfn_trail(x) ⇒ Boolean

Checks whether the given object is a CfnTrail.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


124
125
126
127
 
# File 'cloud_trail/cfn_trail.rb', line 124

def self.is_cfn_trail(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudtrail.CfnTrail", "isCfnTrail", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'cloud_trail/cfn_trail.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_sns_topic_arn => { kind: :property, name: "attrSnsTopicArn", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :trail_ref => { kind: :property, name: "trailRef", is_optional: false },
    :is_logging => { kind: :property, name: "isLogging", is_optional: false },
    :s3_bucket_name => { kind: :property, name: "s3BucketName", is_optional: false },
    :advanced_event_selectors => { kind: :property, name: "advancedEventSelectors", is_optional: true },
    :aggregation_configurations => { kind: :property, name: "aggregationConfigurations", is_optional: true },
    :cloud_watch_logs_log_group_arn => { kind: :property, name: "cloudWatchLogsLogGroupArn", is_optional: true },
    :cloud_watch_logs_role_arn => { kind: :property, name: "cloudWatchLogsRoleArn", is_optional: true },
    :enable_log_file_validation => { kind: :property, name: "enableLogFileValidation", is_optional: true },
    :event_selectors => { kind: :property, name: "eventSelectors", is_optional: true },
    :include_global_service_events => { kind: :property, name: "includeGlobalServiceEvents", is_optional: true },
    :insight_selectors => { kind: :property, name: "insightSelectors", is_optional: true },
    :is_multi_region_trail => { kind: :property, name: "isMultiRegionTrail", is_optional: true },
    :is_organization_trail => { kind: :property, name: "isOrganizationTrail", is_optional: true },
    :kms_key_id => { kind: :property, name: "kmsKeyId", is_optional: true },
    :s3_key_prefix => { kind: :property, name: "s3KeyPrefix", is_optional: true },
    :sns_topic_name => { kind: :property, name: "snsTopicName", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :trail_name => { kind: :property, name: "trailName", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



499
500
501
502
 
# File 'cloud_trail/cfn_trail.rb', line 499

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



511
512
513
514
 
# File 'cloud_trail/cfn_trail.rb', line 511

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



521
522
523
524
 
# File 'cloud_trail/cfn_trail.rb', line 521

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



532
533
534
535
536
 
# File 'cloud_trail/cfn_trail.rb', line 532

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


589
590
591
592
593
 
# File 'cloud_trail/cfn_trail.rb', line 589

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



599
600
601
602
 
# File 'cloud_trail/cfn_trail.rb', line 599

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



611
612
613
614
615
 
# File 'cloud_trail/cfn_trail.rb', line 611

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#advanced_event_selectors ⇒ AWSCDK::IResolvable, ...

Specifies the settings for advanced event selectors.

Returns:



281
282
283
 
# File 'cloud_trail/cfn_trail.rb', line 281

def advanced_event_selectors()
  jsii_get_property("advancedEventSelectors")
end

#advanced_event_selectors=(value) ⇒ Object 



285
286
287
288
 
# File 'cloud_trail/cfn_trail.rb', line 285

def advanced_event_selectors=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR0cmFpbC5DZm5UcmFpbC5BZHZhbmNlZEV2ZW50U2VsZWN0b3JQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "advancedEventSelectors") unless value.nil?
  jsii_set_property("advancedEventSelectors", value)
end

#aggregation_configurations ⇒ AWSCDK::IResolvable, ...

Specifies the aggregation configuration to aggregate CloudTrail Events.

Returns:



293
294
295
 
# File 'cloud_trail/cfn_trail.rb', line 293

def aggregation_configurations()
  jsii_get_property("aggregationConfigurations")
end

#aggregation_configurations=(value) ⇒ Object 



297
298
299
300
 
# File 'cloud_trail/cfn_trail.rb', line 297

def aggregation_configurations=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR0cmFpbC5DZm5UcmFpbC5BZ2dyZWdhdGlvbkNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "aggregationConfigurations") unless value.nil?
  jsii_set_property("aggregationConfigurations", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



624
625
626
627
 
# File 'cloud_trail/cfn_trail.rb', line 624

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



646
647
648
649
650
651
 
# File 'cloud_trail/cfn_trail.rb', line 646

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

Ref returns the ARN of the CloudTrail trail, such as arn:aws:cloudtrail:us-east-2:123456789012:trail/myCloudTrail .

Returns:

  • (String) 


229
230
231
 
# File 'cloud_trail/cfn_trail.rb', line 229

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_sns_topic_arn ⇒ String

Ref returns the ARN of the Amazon topic that's associated with the CloudTrail trail, such as arn:aws:sns:us-east-2:123456789012:mySNSTopic .

Returns:

  • (String) 


236
237
238
 
# File 'cloud_trail/cfn_trail.rb', line 236

def attr_sns_topic_arn()
  jsii_get_property("attrSnsTopicArn")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



175
176
177
 
# File 'cloud_trail/cfn_trail.rb', line 175

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


180
181
182
 
# File 'cloud_trail/cfn_trail.rb', line 180

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


655
656
657
658
 
# File 'cloud_trail/cfn_trail.rb', line 655

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


185
186
187
 
# File 'cloud_trail/cfn_trail.rb', line 185

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


192
193
194
 
# File 'cloud_trail/cfn_trail.rb', line 192

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#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 are delivered.

Returns:

  • (String, nil) 


305
306
307
 
# File 'cloud_trail/cfn_trail.rb', line 305

def cloud_watch_logs_log_group_arn()
  jsii_get_property("cloudWatchLogsLogGroupArn")
end

#cloud_watch_logs_log_group_arn=(value) ⇒ Object 



309
310
311
312
 
# File 'cloud_trail/cfn_trail.rb', line 309

def cloud_watch_logs_log_group_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cloudWatchLogsLogGroupArn") unless value.nil?
  jsii_set_property("cloudWatchLogsLogGroupArn", value)
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, nil) 


317
318
319
 
# File 'cloud_trail/cfn_trail.rb', line 317

def cloud_watch_logs_role_arn()
  jsii_get_property("cloudWatchLogsRoleArn")
end

#cloud_watch_logs_role_arn=(value) ⇒ Object 



321
322
323
324
 
# File 'cloud_trail/cfn_trail.rb', line 321

def cloud_watch_logs_role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cloudWatchLogsRoleArn") unless value.nil?
  jsii_set_property("cloudWatchLogsRoleArn", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


137
138
139
 
# File 'cloud_trail/cfn_trail.rb', line 137

def creation_stack()
  jsii_get_property("creationStack")
end

#enable_log_file_validation ⇒ Boolean, ...

Specifies whether log file validation is enabled.

The default is false.

Returns:



331
332
333
 
# File 'cloud_trail/cfn_trail.rb', line 331

def enable_log_file_validation()
  jsii_get_property("enableLogFileValidation")
end

#enable_log_file_validation=(value) ⇒ Object 



335
336
337
338
 
# File 'cloud_trail/cfn_trail.rb', line 335

def enable_log_file_validation=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableLogFileValidation") unless value.nil?
  jsii_set_property("enableLogFileValidation", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



197
198
199
 
# File 'cloud_trail/cfn_trail.rb', line 197

def env()
  jsii_get_property("env")
end

#event_selectors ⇒ AWSCDK::IResolvable, ...

Use event selectors to further specify the management and data event settings for your trail.

Returns:



343
344
345
 
# File 'cloud_trail/cfn_trail.rb', line 343

def event_selectors()
  jsii_get_property("eventSelectors")
end

#event_selectors=(value) ⇒ Object 



347
348
349
350
 
# File 'cloud_trail/cfn_trail.rb', line 347

def event_selectors=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR0cmFpbC5DZm5UcmFpbC5FdmVudFNlbGVjdG9yUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "eventSelectors") unless value.nil?
  jsii_set_property("eventSelectors", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



668
669
670
671
672
 
# File 'cloud_trail/cfn_trail.rb', line 668

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



679
680
681
682
 
# File 'cloud_trail/cfn_trail.rb', line 679

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#include_global_service_events ⇒ Boolean, ...

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

Returns:



355
356
357
 
# File 'cloud_trail/cfn_trail.rb', line 355

def include_global_service_events()
  jsii_get_property("includeGlobalServiceEvents")
end

#include_global_service_events=(value) ⇒ Object 



359
360
361
362
 
# File 'cloud_trail/cfn_trail.rb', line 359

def include_global_service_events=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "includeGlobalServiceEvents") unless value.nil?
  jsii_set_property("includeGlobalServiceEvents", value)
end

#insight_selectors ⇒ AWSCDK::IResolvable, ...

A JSON string that contains the Insights types you want to log on a trail.

Returns:



367
368
369
 
# File 'cloud_trail/cfn_trail.rb', line 367

def insight_selectors()
  jsii_get_property("insightSelectors")
end

#insight_selectors=(value) ⇒ Object 



371
372
373
374
 
# File 'cloud_trail/cfn_trail.rb', line 371

def insight_selectors=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR0cmFpbC5DZm5UcmFpbC5JbnNpZ2h0U2VsZWN0b3JQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "insightSelectors") unless value.nil?
  jsii_set_property("insightSelectors", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



749
750
751
752
 
# File 'cloud_trail/cfn_trail.rb', line 749

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#is_logging ⇒ Boolean, AWSCDK::IResolvable

Whether the CloudTrail trail is currently logging AWS API calls.

Returns:



257
258
259
 
# File 'cloud_trail/cfn_trail.rb', line 257

def is_logging()
  jsii_get_property("isLogging")
end

#is_logging=(value) ⇒ Object 



261
262
263
264
 
# File 'cloud_trail/cfn_trail.rb', line 261

def is_logging=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "isLogging")
  jsii_set_property("isLogging", value)
end

#is_multi_region_trail ⇒ Boolean, ...

Specifies whether the trail applies only to the current Region or to all Regions.

Returns:



379
380
381
 
# File 'cloud_trail/cfn_trail.rb', line 379

def is_multi_region_trail()
  jsii_get_property("isMultiRegionTrail")
end

#is_multi_region_trail=(value) ⇒ Object 



383
384
385
386
 
# File 'cloud_trail/cfn_trail.rb', line 383

def is_multi_region_trail=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "isMultiRegionTrail") unless value.nil?
  jsii_set_property("isMultiRegionTrail", value)
end

#is_organization_trail ⇒ Boolean, ...

Specifies whether the trail is applied to all accounts in an organization in AWS Organizations , or only for the current AWS account .

Returns:



391
392
393
 
# File 'cloud_trail/cfn_trail.rb', line 391

def is_organization_trail()
  jsii_get_property("isOrganizationTrail")
end

#is_organization_trail=(value) ⇒ Object 



395
396
397
398
 
# File 'cloud_trail/cfn_trail.rb', line 395

def is_organization_trail=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "isOrganizationTrail") unless value.nil?
  jsii_set_property("isOrganizationTrail", value)
end

#kms_key_id ⇒ String?

Specifies the AWS key ID to use to encrypt the logs and digest files delivered by CloudTrail.

Returns:

  • (String, nil) 


403
404
405
 
# File 'cloud_trail/cfn_trail.rb', line 403

def kms_key_id()
  jsii_get_property("kmsKeyId")
end

#kms_key_id=(value) ⇒ Object 



407
408
409
410
 
# File 'cloud_trail/cfn_trail.rb', line 407

def kms_key_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyId") unless value.nil?
  jsii_set_property("kmsKeyId", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


149
150
151
 
# File 'cloud_trail/cfn_trail.rb', line 149

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


132
133
134
 
# File 'cloud_trail/cfn_trail.rb', line 132

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



690
691
692
 
# File 'cloud_trail/cfn_trail.rb', line 690

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



697
698
699
 
# File 'cloud_trail/cfn_trail.rb', line 697

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



490
491
492
493
 
# File 'cloud_trail/cfn_trail.rb', line 490

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


168
169
170
 
# File 'cloud_trail/cfn_trail.rb', line 168

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



708
709
710
711
 
# File 'cloud_trail/cfn_trail.rb', line 708

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


715
716
717
718
 
# File 'cloud_trail/cfn_trail.rb', line 715

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



725
726
727
728
729
 
# File 'cloud_trail/cfn_trail.rb', line 725

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#s3_bucket_name ⇒ String

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

Returns:

  • (String) 


269
270
271
 
# File 'cloud_trail/cfn_trail.rb', line 269

def s3_bucket_name()
  jsii_get_property("s3BucketName")
end

#s3_bucket_name=(value) ⇒ Object 



273
274
275
276
 
# File 'cloud_trail/cfn_trail.rb', line 273

def s3_bucket_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3BucketName")
  jsii_set_property("s3BucketName", value)
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.

Returns:

  • (String, nil) 


415
416
417
 
# File 'cloud_trail/cfn_trail.rb', line 415

def s3_key_prefix()
  jsii_get_property("s3KeyPrefix")
end

#s3_key_prefix=(value) ⇒ Object 



419
420
421
422
 
# File 'cloud_trail/cfn_trail.rb', line 419

def s3_key_prefix=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3KeyPrefix") unless value.nil?
  jsii_set_property("s3KeyPrefix", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



734
735
736
 
# File 'cloud_trail/cfn_trail.rb', line 734

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#sns_topic_name ⇒ String?

Specifies the name or ARN of the Amazon SNS topic defined for notification of log file delivery.

Returns:

  • (String, nil) 


427
428
429
 
# File 'cloud_trail/cfn_trail.rb', line 427

def sns_topic_name()
  jsii_get_property("snsTopicName")
end

#sns_topic_name=(value) ⇒ Object 



431
432
433
434
 
# File 'cloud_trail/cfn_trail.rb', line 431

def sns_topic_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "snsTopicName") unless value.nil?
  jsii_set_property("snsTopicName", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



158
159
160
 
# File 'cloud_trail/cfn_trail.rb', line 158

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



243
244
245
 
# File 'cloud_trail/cfn_trail.rb', line 243

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

A custom set of tags (key-value pairs) for this trail.

Returns:



439
440
441
 
# File 'cloud_trail/cfn_trail.rb', line 439

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



443
444
445
446
447
 
# File 'cloud_trail/cfn_trail.rb', line 443

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



466
467
468
 
# File 'cloud_trail/cfn_trail.rb', line 466

def to_string()
  jsii_call_method("toString", [])
end

#trail_name ⇒ String?

Specifies the name of the trail.

The name must meet the following requirements:.

Returns:

  • (String, nil) 


454
455
456
 
# File 'cloud_trail/cfn_trail.rb', line 454

def trail_name()
  jsii_get_property("trailName")
end

#trail_name=(value) ⇒ Object 



458
459
460
461
 
# File 'cloud_trail/cfn_trail.rb', line 458

def trail_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "trailName") unless value.nil?
  jsii_set_property("trailName", value)
end

#trail_ref ⇒ AWSCDK::Interfaces::AWSCloudtrail::TrailReference

A reference to a Trail resource.

Returns:



250
251
252
 
# File 'cloud_trail/cfn_trail.rb', line 250

def trail_ref()
  jsii_get_property("trailRef")
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


205
206
207
 
# File 'cloud_trail/cfn_trail.rb', line 205

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


215
216
217
 
# File 'cloud_trail/cfn_trail.rb', line 215

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


740
741
742
743
 
# File 'cloud_trail/cfn_trail.rb', line 740

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


479
480
481
482
483
484
 
# File 'cloud_trail/cfn_trail.rb', line 479

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end