Class: Aws::SecurityIR::Types::CreateMembershipRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:membership_name]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

<note markdown=“1”> 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.

</note>

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

Returns:

  • (String) 


435
436
437
438
439
440
441
442
443
444
 
# File 'lib/aws-sdk-securityir/types.rb', line 435

class CreateMembershipRequest < Struct.new(
  :client_token,
  :membership_name,
  :incident_response_team,
  :opt_in_features,
  :tags,
  :cover_entire_organization)
  SENSITIVE = [:membership_name]
  include Aws::Structure
end

#cover_entire_organization ⇒ Boolean

The ‘coverEntireOrganization` parameter is a boolean flag that determines whether the membership should be applied to the entire Amazon Web Services Organization. When set to true, the membership will be created for all accounts within the organization. When set to false, the membership will only be created for specified accounts.

This parameter is optional. If not specified, the default value is false.

  • If set to true: The membership will automatically include all existing and future accounts in the Amazon Web Services Organization.

  • If set to false: The membership will only apply to explicitly specified accounts.

Returns:

  • (Boolean) 


435
436
437
438
439
440
441
442
443
444
 
# File 'lib/aws-sdk-securityir/types.rb', line 435

class CreateMembershipRequest < Struct.new(
  :client_token,
  :membership_name,
  :incident_response_team,
  :opt_in_features,
  :tags,
  :cover_entire_organization)
  SENSITIVE = [:membership_name]
  include Aws::Structure
end

#incident_response_team ⇒ Array<Types::IncidentResponder>

Required element used in combination with CreateMembership to add customer incident response team members and trusted partners to the membership.

Returns:



435
436
437
438
439
440
441
442
443
444
 
# File 'lib/aws-sdk-securityir/types.rb', line 435

class CreateMembershipRequest < Struct.new(
  :client_token,
  :membership_name,
  :incident_response_team,
  :opt_in_features,
  :tags,
  :cover_entire_organization)
  SENSITIVE = [:membership_name]
  include Aws::Structure
end

#membership_name ⇒ String

Required element used in combination with CreateMembership to create a name for the membership.

Returns:

  • (String) 


435
436
437
438
439
440
441
442
443
444
 
# File 'lib/aws-sdk-securityir/types.rb', line 435

class CreateMembershipRequest < Struct.new(
  :client_token,
  :membership_name,
  :incident_response_team,
  :opt_in_features,
  :tags,
  :cover_entire_organization)
  SENSITIVE = [:membership_name]
  include Aws::Structure
end

#opt_in_features ⇒ Array<Types::OptInFeature>

Optional element to enable the monitoring and investigation opt-in features for the service.

Returns:



435
436
437
438
439
440
441
442
443
444
 
# File 'lib/aws-sdk-securityir/types.rb', line 435

class CreateMembershipRequest < Struct.new(
  :client_token,
  :membership_name,
  :incident_response_team,
  :opt_in_features,
  :tags,
  :cover_entire_organization)
  SENSITIVE = [:membership_name]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Optional element for customer configured tags.

Returns:

  • (Hash<String,String>) 


435
436
437
438
439
440
441
442
443
444
 
# File 'lib/aws-sdk-securityir/types.rb', line 435

class CreateMembershipRequest < Struct.new(
  :client_token,
  :membership_name,
  :incident_response_team,
  :opt_in_features,
  :tags,
  :cover_entire_organization)
  SENSITIVE = [:membership_name]
  include Aws::Structure
end