Class: AWSCDK::AIOps::CfnInvestigationGroup

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSAiops::IInvestigationGroupRef
Defined in:
ai_ops/cfn_investigation_group.rb

Overview

Creates an investigation group in your account.

Creating an investigation group is a one-time setup task for each Region in your account. It is a necessary task to be able to perform investigations.

Settings in the investigation group help you centrally manage the common properties of your investigations, such as the following:

  • Who can access the investigations
  • Whether investigation data is encrypted with a customer managed AWS Key Management Service key.
  • How long investigations and their data are retained by default.

Currently, you can have one investigation group in each Region in your account. Each investigation in a Region is a part of the investigation group in that Region

To create an investigation group and set up CloudWatch investigations, you must be signed in to an IAM principal that has either the AIOpsConsoleAdminPolicy or the AdministratorAccess IAM policy attached, or to an account that has similar permissions.

You can configure CloudWatch alarms to start investigations and add events to investigations. If you create your investigation group with CreateInvestigationGroup and you want to enable alarms to do this, you must use PutInvestigationGroupPolicy to create a resource policy that grants this permission to CloudWatch alarms.

For more information about configuring CloudWatch alarms, see Using Amazon CloudWatch alarms

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnInvestigationGroup

Create a new AWS::AIOps::InvestigationGroup.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::AIOps::CfnInvestigationGroupProps) —

    Resource properties.



34
35
36
37
38
39
40
 
# File 'ai_ops/cfn_investigation_group.rb', line 34

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::AIOps::CfnInvestigationGroupProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYWlvcHMuQ2ZuSW52ZXN0aWdhdGlvbkdyb3VwUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_investigation_group(resource) ⇒ String

Parameters:

Returns:

  • (String) 


101
102
103
104
 
# File 'ai_ops/cfn_investigation_group.rb', line 101

def self.arn_for_investigation_group(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19haW9wcy5JSW52ZXN0aWdhdGlvbkdyb3VwUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_aiops.CfnInvestigationGroup", "arnForInvestigationGroup", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


208
209
210
 
# File 'ai_ops/cfn_investigation_group.rb', line 208

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

.is_cfn_investigation_group(x) ⇒ Boolean

Checks whether the given object is a CfnInvestigationGroup.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


110
111
112
113
 
# File 'ai_ops/cfn_investigation_group.rb', line 110

def self.is_cfn_investigation_group(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_aiops.CfnInvestigationGroup", "isCfnInvestigationGroup", [x])
end

.jsii_overridable_methods ⇒ Object 



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
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'ai_ops/cfn_investigation_group.rb', line 42

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_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_created_by => { kind: :property, name: "attrCreatedBy", is_optional: false },
    :attr_last_modified_at => { kind: :property, name: "attrLastModifiedAt", is_optional: false },
    :attr_last_modified_by => { kind: :property, name: "attrLastModifiedBy", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :investigation_group_ref => { kind: :property, name: "investigationGroupRef", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :chatbot_notification_channels => { kind: :property, name: "chatbotNotificationChannels", is_optional: true },
    :cross_account_configurations => { kind: :property, name: "crossAccountConfigurations", is_optional: true },
    :encryption_config => { kind: :property, name: "encryptionConfig", is_optional: true },
    :investigation_group_policy => { kind: :property, name: "investigationGroupPolicy", is_optional: true },
    :is_cloud_trail_event_history_enabled => { kind: :property, name: "isCloudTrailEventHistoryEnabled", is_optional: true },
    :retention_in_days => { kind: :property, name: "retentionInDays", is_optional: true },
    :role_arn => { kind: :property, name: "roleArn", is_optional: true },
    :tag_key_boundaries => { kind: :property, name: "tagKeyBoundaries", is_optional: true },
    :tags => { kind: :property, name: "tags", 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.



419
420
421
422
 
# File 'ai_ops/cfn_investigation_group.rb', line 419

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:



431
432
433
434
 
# File 'ai_ops/cfn_investigation_group.rb', line 431

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:



441
442
443
444
 
# File 'ai_ops/cfn_investigation_group.rb', line 441

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:



452
453
454
455
456
 
# File 'ai_ops/cfn_investigation_group.rb', line 452

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.


509
510
511
512
513
 
# File 'ai_ops/cfn_investigation_group.rb', line 509

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.



519
520
521
522
 
# File 'ai_ops/cfn_investigation_group.rb', line 519

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.



531
532
533
534
535
 
# File 'ai_ops/cfn_investigation_group.rb', line 531

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

#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:



544
545
546
547
 
# File 'ai_ops/cfn_investigation_group.rb', line 544

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:



566
567
568
569
570
571
 
# File 'ai_ops/cfn_investigation_group.rb', line 566

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

The Amazon Resource Name (ARN) of the investigation group.

Returns:

  • (String) 


215
216
217
 
# File 'ai_ops/cfn_investigation_group.rb', line 215

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_created_at ⇒ String

The date and time that the investigation group was created.

Returns:

  • (String) 


222
223
224
 
# File 'ai_ops/cfn_investigation_group.rb', line 222

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_created_by ⇒ String

The name of the user who created the investigation group.

Returns:

  • (String) 


229
230
231
 
# File 'ai_ops/cfn_investigation_group.rb', line 229

def attr_created_by()
  jsii_get_property("attrCreatedBy")
end

#attr_last_modified_at ⇒ String

The date and time that the investigation group was most recently modified.

Returns:

  • (String) 


236
237
238
 
# File 'ai_ops/cfn_investigation_group.rb', line 236

def attr_last_modified_at()
  jsii_get_property("attrLastModifiedAt")
end

#attr_last_modified_by ⇒ String

The name of the user who created the investigation group.

Returns:

  • (String) 


243
244
245
 
# File 'ai_ops/cfn_investigation_group.rb', line 243

def attr_last_modified_by()
  jsii_get_property("attrLastModifiedBy")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



250
251
252
 
# File 'ai_ops/cfn_investigation_group.rb', line 250

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



161
162
163
 
# File 'ai_ops/cfn_investigation_group.rb', line 161

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


166
167
168
 
# File 'ai_ops/cfn_investigation_group.rb', line 166

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


575
576
577
578
 
# File 'ai_ops/cfn_investigation_group.rb', line 575

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}) 


171
172
173
 
# File 'ai_ops/cfn_investigation_group.rb', line 171

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


178
179
180
 
# File 'ai_ops/cfn_investigation_group.rb', line 178

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#chatbot_notification_channels ⇒ AWSCDK::IResolvable, ...

Use this property to integrate CloudWatch investigations with chat applications.

Returns:



276
277
278
 
# File 'ai_ops/cfn_investigation_group.rb', line 276

def chatbot_notification_channels()
  jsii_get_property("chatbotNotificationChannels")
end

#chatbot_notification_channels=(value) ⇒ Object 



280
281
282
283
 
# File 'ai_ops/cfn_investigation_group.rb', line 280

def chatbot_notification_channels=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYWlvcHMuQ2ZuSW52ZXN0aWdhdGlvbkdyb3VwLkNoYXRib3ROb3RpZmljYXRpb25DaGFubmVsUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "chatbotNotificationChannels") unless value.nil?
  jsii_set_property("chatbotNotificationChannels", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


123
124
125
 
# File 'ai_ops/cfn_investigation_group.rb', line 123

def creation_stack()
  jsii_get_property("creationStack")
end

#cross_account_configurations ⇒ AWSCDK::IResolvable, ...

List of sourceRoleArn values that have been configured for cross-account access.

Returns:



288
289
290
 
# File 'ai_ops/cfn_investigation_group.rb', line 288

def ()
  jsii_get_property("crossAccountConfigurations")
end

#cross_account_configurations=(value) ⇒ Object 



292
293
294
295
 
# File 'ai_ops/cfn_investigation_group.rb', line 292

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

#encryption_config ⇒ AWSCDK::IResolvable, ...

Specifies the customer managed AWS key that the investigation group uses to encrypt data, if there is one.

Returns:



300
301
302
 
# File 'ai_ops/cfn_investigation_group.rb', line 300

def encryption_config()
  jsii_get_property("encryptionConfig")
end

#encryption_config=(value) ⇒ Object 



304
305
306
307
308
 
# File 'ai_ops/cfn_investigation_group.rb', line 304

def encryption_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AIOps::CfnInvestigationGroup::EncryptionConfigMapProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19haW9wcy5DZm5JbnZlc3RpZ2F0aW9uR3JvdXAuRW5jcnlwdGlvbkNvbmZpZ01hcFByb3BlcnR5In1dfX0=")), "encryptionConfig") unless value.nil?
  jsii_set_property("encryptionConfig", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



183
184
185
 
# File 'ai_ops/cfn_investigation_group.rb', line 183

def env()
  jsii_get_property("env")
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:



588
589
590
591
592
 
# File 'ai_ops/cfn_investigation_group.rb', line 588

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:



599
600
601
602
 
# File 'ai_ops/cfn_investigation_group.rb', line 599

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



669
670
671
672
 
# File 'ai_ops/cfn_investigation_group.rb', line 669

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

#investigation_group_policy ⇒ String?

Returns the JSON of the IAM resource policy associated with the specified investigation group in a string.

Returns:

  • (String, nil) 


313
314
315
 
# File 'ai_ops/cfn_investigation_group.rb', line 313

def investigation_group_policy()
  jsii_get_property("investigationGroupPolicy")
end

#investigation_group_policy=(value) ⇒ Object 



317
318
319
320
 
# File 'ai_ops/cfn_investigation_group.rb', line 317

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

#investigation_group_ref ⇒ AWSCDK::Interfaces::AWSAiops::InvestigationGroupReference

A reference to a InvestigationGroup resource.

Returns:



257
258
259
 
# File 'ai_ops/cfn_investigation_group.rb', line 257

def investigation_group_ref()
  jsii_get_property("investigationGroupRef")
end

#is_cloud_trail_event_history_enabled ⇒ Boolean, ...

Specify true to enable CloudWatch investigations to have access to change events that are recorded by CloudTrail.

Returns:



325
326
327
 
# File 'ai_ops/cfn_investigation_group.rb', line 325

def is_cloud_trail_event_history_enabled()
  jsii_get_property("isCloudTrailEventHistoryEnabled")
end

#is_cloud_trail_event_history_enabled=(value) ⇒ Object 



329
330
331
332
 
# File 'ai_ops/cfn_investigation_group.rb', line 329

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


135
136
137
 
# File 'ai_ops/cfn_investigation_group.rb', line 135

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

Specify either the name or the ARN of the investigation group that you want to view.

Returns:

  • (String) 


264
265
266
 
# File 'ai_ops/cfn_investigation_group.rb', line 264

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



268
269
270
271
 
# File 'ai_ops/cfn_investigation_group.rb', line 268

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


118
119
120
 
# File 'ai_ops/cfn_investigation_group.rb', line 118

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:



610
611
612
 
# File 'ai_ops/cfn_investigation_group.rb', line 610

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:



617
618
619
 
# File 'ai_ops/cfn_investigation_group.rb', line 617

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.



410
411
412
413
 
# File 'ai_ops/cfn_investigation_group.rb', line 410

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) 


154
155
156
 
# File 'ai_ops/cfn_investigation_group.rb', line 154

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:



628
629
630
631
 
# File 'ai_ops/cfn_investigation_group.rb', line 628

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}) 


635
636
637
638
 
# File 'ai_ops/cfn_investigation_group.rb', line 635

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:



645
646
647
648
649
 
# File 'ai_ops/cfn_investigation_group.rb', line 645

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

#retention_in_days ⇒ Numeric?

Specifies how long that investigation data is kept.

Returns:

  • (Numeric, nil) 


337
338
339
 
# File 'ai_ops/cfn_investigation_group.rb', line 337

def retention_in_days()
  jsii_get_property("retentionInDays")
end

#retention_in_days=(value) ⇒ Object 



341
342
343
344
 
# File 'ai_ops/cfn_investigation_group.rb', line 341

def retention_in_days=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "retentionInDays") unless value.nil?
  jsii_set_property("retentionInDays", value)
end

#role_arn ⇒ String?

The ARN of the IAM role that the investigation group uses for permissions to gather data.

Returns:

  • (String, nil) 


349
350
351
 
# File 'ai_ops/cfn_investigation_group.rb', line 349

def role_arn()
  jsii_get_property("roleArn")
end

#role_arn=(value) ⇒ Object 



353
354
355
356
 
# File 'ai_ops/cfn_investigation_group.rb', line 353

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



654
655
656
 
# File 'ai_ops/cfn_investigation_group.rb', line 654

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



144
145
146
 
# File 'ai_ops/cfn_investigation_group.rb', line 144

def stack()
  jsii_get_property("stack")
end

#tag_key_boundaries ⇒ Array<String>?

Displays the custom tag keys for custom applications in your system that you have specified in the investigation group.

Returns:

  • (Array<String>, nil) 


361
362
363
 
# File 'ai_ops/cfn_investigation_group.rb', line 361

def tag_key_boundaries()
  jsii_get_property("tagKeyBoundaries")
end

#tag_key_boundaries=(value) ⇒ Object 



365
366
367
368
 
# File 'ai_ops/cfn_investigation_group.rb', line 365

def tag_key_boundaries=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagKeyBoundaries") unless value.nil?
  jsii_set_property("tagKeyBoundaries", value)
end

#tags ⇒ Array<AWSCDK::CfnTag>?

The list of key-value pairs to associate with the resource.

Returns:



373
374
375
 
# File 'ai_ops/cfn_investigation_group.rb', line 373

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



377
378
379
380
381
 
# File 'ai_ops/cfn_investigation_group.rb', line 377

def tags=(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=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



386
387
388
 
# File 'ai_ops/cfn_investigation_group.rb', line 386

def to_string()
  jsii_call_method("toString", [])
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}) 


191
192
193
 
# File 'ai_ops/cfn_investigation_group.rb', line 191

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}) 


201
202
203
 
# File 'ai_ops/cfn_investigation_group.rb', line 201

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


660
661
662
663
 
# File 'ai_ops/cfn_investigation_group.rb', line 660

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) 


399
400
401
402
403
404
 
# File 'ai_ops/cfn_investigation_group.rb', line 399

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