Class: Aws::ResourceExplorer2::Types::CreateViewInput

Inherits:

Struct

• Object
• Struct
• Aws::ResourceExplorer2::Types::CreateViewInput

Includes:

Structure

Defined in:

lib/aws-sdk-resourceexplorer2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:filters, :tags]

Instance Attribute Summary

• #client_token ⇒ String

  This value helps ensure idempotency.

• #filters ⇒ Types::SearchFilter

  An array of strings that specify which resources are included in the results of queries made using this view.

• #included_properties ⇒ Array<Types::IncludedProperty>

  Specifies optional fields that you want included in search results from this view.

• #scope ⇒ String

  The root ARN of the account, an organizational unit (OU), or an organization ARN.

• #tags ⇒ Hash<String,String>

  Tag key and value pairs that are attached to the view.

• #view_name ⇒ String

  The name of the new view.

Instance Attribute Details

#client_token ⇒ String

This value helps ensure idempotency. Resource Explorer uses this value to prevent the accidental creation of duplicate versions. We recommend that you generate a [UUID-type value] to ensure the uniqueness of your views.

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

[1]: wikipedia.org/wiki/Universally_unique_identifier

Returns:

• (String)

# File 'lib/aws-sdk-resourceexplorer2/types.rb', line 279

class CreateViewInput < Struct.new(
  :client_token,
  :filters,
  :included_properties,
  :scope,
  :tags,
  :view_name)
  SENSITIVE = [:filters, :tags]
  include Aws::Structure
end

#filters ⇒ Types::SearchFilter

An array of strings that specify which resources are included in the results of queries made using this view. When you use this view in a Search operation, the filter string is combined with the search’s ‘QueryString` parameter using a logical `AND` operator.

For information about the supported syntax, see [Search query reference for Resource Explorer] in the *Amazon Web Services Resource Explorer User Guide*.

This query string in the context of this operation supports only

filter prefixes][2

with optional [operators]. It doesn’t

support free-form text. For example, the string ‘region:us* service:ec2 -tag:stage=prod` includes all Amazon EC2 resources in any Amazon Web Services Region that begins with the letters `us` and is not tagged with a key `Stage` that has the value `prod`.

[1]: docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html [2]: docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters [3]: docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators

Returns:

• (Types::SearchFilter)

# File 'lib/aws-sdk-resourceexplorer2/types.rb', line 279

class CreateViewInput < Struct.new(
  :client_token,
  :filters,
  :included_properties,
  :scope,
  :tags,
  :view_name)
  SENSITIVE = [:filters, :tags]
  include Aws::Structure
end

#included_properties ⇒ Array<Types::IncludedProperty>

Specifies optional fields that you want included in search results from this view. It is a list of objects that each describe a field to include.

The default is an empty list, with no optional fields included in the results.

Returns:

• (Array<Types::IncludedProperty>)

# File 'lib/aws-sdk-resourceexplorer2/types.rb', line 279

class CreateViewInput < Struct.new(
  :client_token,
  :filters,
  :included_properties,
  :scope,
  :tags,
  :view_name)
  SENSITIVE = [:filters, :tags]
  include Aws::Structure
end

#scope ⇒ String

The root ARN of the account, an organizational unit (OU), or an organization ARN. If left empty, the default is account.

Returns:

• (String)

# File 'lib/aws-sdk-resourceexplorer2/types.rb', line 279

class CreateViewInput < Struct.new(
  :client_token,
  :filters,
  :included_properties,
  :scope,
  :tags,
  :view_name)
  SENSITIVE = [:filters, :tags]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Tag key and value pairs that are attached to the view.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-resourceexplorer2/types.rb', line 279

class CreateViewInput < Struct.new(
  :client_token,
  :filters,
  :included_properties,
  :scope,
  :tags,
  :view_name)
  SENSITIVE = [:filters, :tags]
  include Aws::Structure
end

#view_name ⇒ String

The name of the new view. This name appears in the list of views in Resource Explorer.

The name must be no more than 64 characters long, and can include letters, digits, and the dash (-) character. The name must be unique within its Amazon Web Services Region.

Returns:

• (String)

# File 'lib/aws-sdk-resourceexplorer2/types.rb', line 279

class CreateViewInput < Struct.new(
  :client_token,
  :filters,
  :included_properties,
  :scope,
  :tags,
  :view_name)
  SENSITIVE = [:filters, :tags]
  include Aws::Structure
end