Class: Aws::SecurityIR::Types::CreateCaseRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:title, :description]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

The clientToken field is an idempotency key used to ensure that repeated attempts for a single action will be ignored by the server during retries. A caller supplied unique ID (typically a UUID) should be provided.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'gems/aws-sdk-securityir/lib/aws-sdk-securityir/types.rb', line 351

class CreateCaseRequest < Struct.new(
  :client_token,
  :resolver_type,
  :title,
  :description,
  :engagement_type,
  :reported_incident_start_date,
  :impacted_accounts,
  :watchers,
  :threat_actor_ip_addresses,
  :impacted_services,
  :impacted_aws_regions,
  :tags)
  SENSITIVE = [:title, :description]
  include Aws::Structure
end

#description ⇒ String

Required element used in combination with CreateCase

to provide a description for the new case.

Returns:

  • (String) 


351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'gems/aws-sdk-securityir/lib/aws-sdk-securityir/types.rb', line 351

class CreateCaseRequest < Struct.new(
  :client_token,
  :resolver_type,
  :title,
  :description,
  :engagement_type,
  :reported_incident_start_date,
  :impacted_accounts,
  :watchers,
  :threat_actor_ip_addresses,
  :impacted_services,
  :impacted_aws_regions,
  :tags)
  SENSITIVE = [:title, :description]
  include Aws::Structure
end

#engagement_type ⇒ String

Required element used in combination with CreateCase to provide an engagement type for the new cases. Available engagement types include Security Incident | Investigation

Returns:

  • (String) 


351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'gems/aws-sdk-securityir/lib/aws-sdk-securityir/types.rb', line 351

class CreateCaseRequest < Struct.new(
  :client_token,
  :resolver_type,
  :title,
  :description,
  :engagement_type,
  :reported_incident_start_date,
  :impacted_accounts,
  :watchers,
  :threat_actor_ip_addresses,
  :impacted_services,
  :impacted_aws_regions,
  :tags)
  SENSITIVE = [:title, :description]
  include Aws::Structure
end

#impacted_accounts ⇒ Array<String>

Required element used in combination with CreateCase to provide a list of impacted accounts.

AWS account ID's may appear less than 12 characters and need to be zero-prepended. An example would be 123123123 which is nine digits, and with zero-prepend would be 000123123123. Not zero-prepending to 12 digits could result in errors.

Returns:

  • (Array<String>) 


351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'gems/aws-sdk-securityir/lib/aws-sdk-securityir/types.rb', line 351

class CreateCaseRequest < Struct.new(
  :client_token,
  :resolver_type,
  :title,
  :description,
  :engagement_type,
  :reported_incident_start_date,
  :impacted_accounts,
  :watchers,
  :threat_actor_ip_addresses,
  :impacted_services,
  :impacted_aws_regions,
  :tags)
  SENSITIVE = [:title, :description]
  include Aws::Structure
end

#impacted_aws_regions ⇒ Array<Types::ImpactedAwsRegion>

An optional element used in combination with CreateCase to provide a list of impacted regions.

Returns:



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'gems/aws-sdk-securityir/lib/aws-sdk-securityir/types.rb', line 351

class CreateCaseRequest < Struct.new(
  :client_token,
  :resolver_type,
  :title,
  :description,
  :engagement_type,
  :reported_incident_start_date,
  :impacted_accounts,
  :watchers,
  :threat_actor_ip_addresses,
  :impacted_services,
  :impacted_aws_regions,
  :tags)
  SENSITIVE = [:title, :description]
  include Aws::Structure
end

#impacted_services ⇒ Array<String>

An optional element used in combination with CreateCase to provide a list of services impacted.

Returns:

  • (Array<String>) 


351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'gems/aws-sdk-securityir/lib/aws-sdk-securityir/types.rb', line 351

class CreateCaseRequest < Struct.new(
  :client_token,
  :resolver_type,
  :title,
  :description,
  :engagement_type,
  :reported_incident_start_date,
  :impacted_accounts,
  :watchers,
  :threat_actor_ip_addresses,
  :impacted_services,
  :impacted_aws_regions,
  :tags)
  SENSITIVE = [:title, :description]
  include Aws::Structure
end

#reported_incident_start_date ⇒ Time

Required element used in combination with CreateCase to provide an initial start date for the unauthorized activity.

Returns:

  • (Time) 


351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'gems/aws-sdk-securityir/lib/aws-sdk-securityir/types.rb', line 351

class CreateCaseRequest < Struct.new(
  :client_token,
  :resolver_type,
  :title,
  :description,
  :engagement_type,
  :reported_incident_start_date,
  :impacted_accounts,
  :watchers,
  :threat_actor_ip_addresses,
  :impacted_services,
  :impacted_aws_regions,
  :tags)
  SENSITIVE = [:title, :description]
  include Aws::Structure
end

#resolver_type ⇒ String

Required element used in combination with CreateCase to identify the resolver type.

Returns:

  • (String) 


351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'gems/aws-sdk-securityir/lib/aws-sdk-securityir/types.rb', line 351

class CreateCaseRequest < Struct.new(
  :client_token,
  :resolver_type,
  :title,
  :description,
  :engagement_type,
  :reported_incident_start_date,
  :impacted_accounts,
  :watchers,
  :threat_actor_ip_addresses,
  :impacted_services,
  :impacted_aws_regions,
  :tags)
  SENSITIVE = [:title, :description]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

An optional element used in combination with CreateCase to add customer specified tags to a case.

Returns:

  • (Hash<String,String>) 


351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'gems/aws-sdk-securityir/lib/aws-sdk-securityir/types.rb', line 351

class CreateCaseRequest < Struct.new(
  :client_token,
  :resolver_type,
  :title,
  :description,
  :engagement_type,
  :reported_incident_start_date,
  :impacted_accounts,
  :watchers,
  :threat_actor_ip_addresses,
  :impacted_services,
  :impacted_aws_regions,
  :tags)
  SENSITIVE = [:title, :description]
  include Aws::Structure
end

#threat_actor_ip_addresses ⇒ Array<Types::ThreatActorIp>

An optional element used in combination with CreateCase to provide a list of suspicious internet protocol addresses associated with unauthorized activity.

Returns:



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'gems/aws-sdk-securityir/lib/aws-sdk-securityir/types.rb', line 351

class CreateCaseRequest < Struct.new(
  :client_token,
  :resolver_type,
  :title,
  :description,
  :engagement_type,
  :reported_incident_start_date,
  :impacted_accounts,
  :watchers,
  :threat_actor_ip_addresses,
  :impacted_services,
  :impacted_aws_regions,
  :tags)
  SENSITIVE = [:title, :description]
  include Aws::Structure
end

#title ⇒ String

Required element used in combination with CreateCase to provide a title for the new case.

Returns:

  • (String) 


351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'gems/aws-sdk-securityir/lib/aws-sdk-securityir/types.rb', line 351

class CreateCaseRequest < Struct.new(
  :client_token,
  :resolver_type,
  :title,
  :description,
  :engagement_type,
  :reported_incident_start_date,
  :impacted_accounts,
  :watchers,
  :threat_actor_ip_addresses,
  :impacted_services,
  :impacted_aws_regions,
  :tags)
  SENSITIVE = [:title, :description]
  include Aws::Structure
end

#watchers ⇒ Array<Types::Watcher>

Required element used in combination with CreateCase to provide a list of entities to receive notifications for case updates.

Returns:



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'gems/aws-sdk-securityir/lib/aws-sdk-securityir/types.rb', line 351

class CreateCaseRequest < Struct.new(
  :client_token,
  :resolver_type,
  :title,
  :description,
  :engagement_type,
  :reported_incident_start_date,
  :impacted_accounts,
  :watchers,
  :threat_actor_ip_addresses,
  :impacted_services,
  :impacted_aws_regions,
  :tags)
  SENSITIVE = [:title, :description]
  include Aws::Structure
end