Class: Aws::AccessAnalyzer::Types::CreateAnalyzerRequest

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

Overview

Note:

When making an API call, you may pass CreateAnalyzerRequest data as a hash:

{
  analyzer_name: "Name", # required
  archive_rules: [
    {
      filter: { # required
        "String" => {
          contains: ["String"],
          eq: ["String"],
          exists: false,
          neq: ["String"],
        },
      },
      rule_name: "Name", # required
    },
  ],
  client_token: "String",
  tags: {
    "String" => "String",
  },
  type: "ACCOUNT", # required, accepts ACCOUNT, ORGANIZATION
}

Creates an analyzer.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#analyzer_name ⇒ String

The name of the analyzer to create.

Returns:

  • (String) 


871
872
873
874
875
876
877
878
879
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 871

class CreateAnalyzerRequest < Struct.new(
  :analyzer_name,
  :archive_rules,
  :client_token,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#archive_rules ⇒ Array<Types::InlineArchiveRule>

Specifies the archive rules to add for the analyzer. Archive rules automatically archive findings that meet the criteria you define for the rule.

Returns:



871
872
873
874
875
876
877
878
879
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 871

class CreateAnalyzerRequest < Struct.new(
  :analyzer_name,
  :archive_rules,
  :client_token,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A client token.

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

Returns:

  • (String) 


871
872
873
874
875
876
877
878
879
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 871

class CreateAnalyzerRequest < Struct.new(
  :analyzer_name,
  :archive_rules,
  :client_token,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags to apply to the analyzer.

Returns:

  • (Hash<String,String>) 


871
872
873
874
875
876
877
878
879
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 871

class CreateAnalyzerRequest < Struct.new(
  :analyzer_name,
  :archive_rules,
  :client_token,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of analyzer to create. Only ACCOUNT and ORGANIZATION analyzers are supported. You can create only one analyzer per account per Region. You can create up to 5 analyzers per organization per Region.

Returns:

  • (String) 


871
872
873
874
875
876
877
878
879
 
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 871

class CreateAnalyzerRequest < Struct.new(
  :analyzer_name,
  :archive_rules,
  :client_token,
  :tags,
  :type)
  SENSITIVE = []
  include Aws::Structure
end