Class: Aws::IoTWireless::Types::CreateWirelessDeviceRequest

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 CreateWirelessDeviceRequest data as a hash:

{
  type: "Sidewalk", # required, accepts Sidewalk, LoRaWAN
  name: "WirelessDeviceName",
  description: "Description",
  destination_name: "DestinationName", # required
  client_request_token: "ClientRequestToken",
  lo_ra_wan: {
    dev_eui: "DevEui",
    device_profile_id: "DeviceProfileId",
    service_profile_id: "ServiceProfileId",
    otaa_v1_1: {
      app_key: "AppKey",
      nwk_key: "NwkKey",
      join_eui: "JoinEui",
    },
    otaa_v1_0_x: {
      app_key: "AppKey",
      app_eui: "AppEui",
      gen_app_key: "GenAppKey",
    },
    abp_v1_1: {
      dev_addr: "DevAddr",
      session_keys: {
        f_nwk_s_int_key: "FNwkSIntKey",
        s_nwk_s_int_key: "SNwkSIntKey",
        nwk_s_enc_key: "NwkSEncKey",
        app_s_key: "AppSKey",
      },
      f_cnt_start: 1,
    },
    abp_v1_0_x: {
      dev_addr: "DevAddr",
      session_keys: {
        nwk_s_key: "NwkSKey",
        app_s_key: "AppSKey",
      },
      f_cnt_start: 1,
    },
    f_ports: {
      fuota: 1,
      multicast: 1,
      clock_sync: 1,
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_token ⇒ String

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) 


982
983
984
985
986
987
988
989
990
991
992
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 982

class CreateWirelessDeviceRequest < Struct.new(
  :type,
  :name,
  :description,
  :destination_name,
  :client_request_token,
  :lo_ra_wan,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the new resource.

Returns:

  • (String) 


982
983
984
985
986
987
988
989
990
991
992
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 982

class CreateWirelessDeviceRequest < Struct.new(
  :type,
  :name,
  :description,
  :destination_name,
  :client_request_token,
  :lo_ra_wan,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#destination_name ⇒ String

The name of the destination to assign to the new wireless device.

Returns:

  • (String) 


982
983
984
985
986
987
988
989
990
991
992
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 982

class CreateWirelessDeviceRequest < Struct.new(
  :type,
  :name,
  :description,
  :destination_name,
  :client_request_token,
  :lo_ra_wan,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#lo_ra_wan ⇒ Types::LoRaWANDevice

The device configuration information to use to create the wireless device.

Returns:



982
983
984
985
986
987
988
989
990
991
992
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 982

class CreateWirelessDeviceRequest < Struct.new(
  :type,
  :name,
  :description,
  :destination_name,
  :client_request_token,
  :lo_ra_wan,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the new resource.

Returns:

  • (String) 


982
983
984
985
986
987
988
989
990
991
992
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 982

class CreateWirelessDeviceRequest < Struct.new(
  :type,
  :name,
  :description,
  :destination_name,
  :client_request_token,
  :lo_ra_wan,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tags to attach to the new wireless device. Tags are metadata that you can use to manage a resource.

Returns:



982
983
984
985
986
987
988
989
990
991
992
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 982

class CreateWirelessDeviceRequest < Struct.new(
  :type,
  :name,
  :description,
  :destination_name,
  :client_request_token,
  :lo_ra_wan,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The wireless device type.

Returns:

  • (String) 


982
983
984
985
986
987
988
989
990
991
992
 
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 982

class CreateWirelessDeviceRequest < Struct.new(
  :type,
  :name,
  :description,
  :destination_name,
  :client_request_token,
  :lo_ra_wan,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end