Class: Aws::FMS::Types::ResourceSet

Inherits:

Struct

• Object
• Struct
• Aws::FMS::Types::ResourceSet

Defined in:

gems/aws-sdk-fms/lib/aws-sdk-fms/types.rb

Overview

A set of resources to include in a policy.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  A description of the resource set.

• #id ⇒ String

  A unique identifier for the resource set.

• #last_update_time ⇒ Time

  The last time that the resource set was changed.

• #name ⇒ String

  The descriptive name of the resource set.

• #resource_set_status ⇒ String

  Indicates whether the resource set is in or out of an admin's Region scope.

• #resource_type_list ⇒ Array<String>

  Determines the resources that can be associated to the resource set.

• #update_token ⇒ String

  An optional token that you can use for optimistic locking.

Instance Attribute Details

#description ⇒ String

A description of the resource set.

Returns:

• (String)

# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/types.rb', line 3896

class ResourceSet < Struct.new(
  :id,
  :name,
  :description,
  :update_token,
  :resource_type_list,
  :last_update_time,
  :resource_set_status)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

A unique identifier for the resource set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Returns:

• (String)

# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/types.rb', line 3896

class ResourceSet < Struct.new(
  :id,
  :name,
  :description,
  :update_token,
  :resource_type_list,
  :last_update_time,
  :resource_set_status)
  SENSITIVE = []
  include Aws::Structure
end

#last_update_time ⇒ Time

The last time that the resource set was changed.

Returns:

• (Time)

# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/types.rb', line 3896

class ResourceSet < Struct.new(
  :id,
  :name,
  :description,
  :update_token,
  :resource_type_list,
  :last_update_time,
  :resource_set_status)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The descriptive name of the resource set. You can't change the name of a resource set after you create it.

Returns:

• (String)

# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/types.rb', line 3896

class ResourceSet < Struct.new(
  :id,
  :name,
  :description,
  :update_token,
  :resource_type_list,
  :last_update_time,
  :resource_set_status)
  SENSITIVE = []
  include Aws::Structure
end

#resource_set_status ⇒ String

Indicates whether the resource set is in or out of an admin's Region scope.

• ACTIVE - The administrator can manage and delete the resource set.

• OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but they can't edit or delete the resource set. Existing protections stay in place. Any new resource that come into scope of the resource set won't be protected.

Returns:

• (String)

# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/types.rb', line 3896

class ResourceSet < Struct.new(
  :id,
  :name,
  :description,
  :update_token,
  :resource_type_list,
  :last_update_time,
  :resource_set_status)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type_list ⇒ Array<String>

Determines the resources that can be associated to the resource set. Depending on your setting for max results and the number of resource sets, a single call might not return the full list.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/types.rb', line 3896

class ResourceSet < Struct.new(
  :id,
  :name,
  :description,
  :update_token,
  :resource_type_list,
  :last_update_time,
  :resource_set_status)
  SENSITIVE = []
  include Aws::Structure
end

#update_token ⇒ String

An optional token that you can use for optimistic locking. Firewall Manager returns a token to your requests that access the resource set. The token marks the state of the resource set resource at the time of the request. Update tokens are not allowed when creating a resource set. After creation, each subsequent update call to the resource set requires the update token.

To make an unconditional change to the resource set, omit the token in your update request. Without the token, Firewall Manager performs your updates regardless of whether the resource set has changed since you last retrieved it.

To make a conditional change to the resource set, provide the token in your update request. Firewall Manager uses the token to ensure that the resource set hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the resource set again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

Returns:

• (String)

# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/types.rb', line 3896

class ResourceSet < Struct.new(
  :id,
  :name,
  :description,
  :update_token,
  :resource_type_list,
  :last_update_time,
  :resource_set_status)
  SENSITIVE = []
  include Aws::Structure
end