Class: Aws::IoTWireless::Types::CreateNetworkAnalyzerConfigurationRequest

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

Overview

Note:

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

{
  name: "NetworkAnalyzerConfigurationName", # required
  trace_content: {
    wireless_device_frame_info: "ENABLED", # accepts ENABLED, DISABLED
    log_level: "INFO", # accepts INFO, ERROR, DISABLED
  },
  wireless_devices: ["WirelessDeviceId"],
  wireless_gateways: ["WirelessGatewayId"],
  description: "Description",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  client_request_token: "ClientRequestToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

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

Returns:

  • (String)


799
800
801
802
803
804
805
806
807
808
809
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 799

class CreateNetworkAnalyzerConfigurationRequest < Struct.new(
  :name,
  :trace_content,
  :wireless_devices,
  :wireless_gateways,
  :description,
  :tags,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the new resource.

Returns:

  • (String)


799
800
801
802
803
804
805
806
807
808
809
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 799

class CreateNetworkAnalyzerConfigurationRequest < Struct.new(
  :name,
  :trace_content,
  :wireless_devices,
  :wireless_gateways,
  :description,
  :tags,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

Name of the network analyzer configuration.

Returns:

  • (String)


799
800
801
802
803
804
805
806
807
808
809
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 799

class CreateNetworkAnalyzerConfigurationRequest < Struct.new(
  :name,
  :trace_content,
  :wireless_devices,
  :wireless_gateways,
  :description,
  :tags,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

Returns:



799
800
801
802
803
804
805
806
807
808
809
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 799

class CreateNetworkAnalyzerConfigurationRequest < Struct.new(
  :name,
  :trace_content,
  :wireless_devices,
  :wireless_gateways,
  :description,
  :tags,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#trace_contentTypes::TraceContent

Trace content for your wireless gateway and wireless device resources.

Returns:



799
800
801
802
803
804
805
806
807
808
809
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 799

class CreateNetworkAnalyzerConfigurationRequest < Struct.new(
  :name,
  :trace_content,
  :wireless_devices,
  :wireless_gateways,
  :description,
  :tags,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#wireless_devicesArray<String>

Wireless device resources to add to the network analyzer configuration. Provide the WirelessDeviceId of the resource to add in the input array.

Returns:

  • (Array<String>)


799
800
801
802
803
804
805
806
807
808
809
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 799

class CreateNetworkAnalyzerConfigurationRequest < Struct.new(
  :name,
  :trace_content,
  :wireless_devices,
  :wireless_gateways,
  :description,
  :tags,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#wireless_gatewaysArray<String>

Wireless gateway resources to add to the network analyzer configuration. Provide the WirelessGatewayId of the resource to add in the input array.

Returns:

  • (Array<String>)


799
800
801
802
803
804
805
806
807
808
809
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 799

class CreateNetworkAnalyzerConfigurationRequest < Struct.new(
  :name,
  :trace_content,
  :wireless_devices,
  :wireless_gateways,
  :description,
  :tags,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end