Class: Aws::IoTWireless::Types::CreateFuotaTaskRequest

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

{
  name: "FuotaTaskName",
  description: "Description",
  client_request_token: "ClientRequestToken",
  lo_ra_wan: {
    rf_region: "EU868", # accepts EU868, US915, AU915, AS923-1
  },
  firmware_update_image: "FirmwareUpdateImage", # required
  firmware_update_role: "FirmwareUpdateRole", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

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)


640
641
642
643
644
645
646
647
648
649
650
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 640

class CreateFuotaTaskRequest < Struct.new(
  :name,
  :description,
  :client_request_token,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the new resource.

Returns:

  • (String)


640
641
642
643
644
645
646
647
648
649
650
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 640

class CreateFuotaTaskRequest < Struct.new(
  :name,
  :description,
  :client_request_token,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#firmware_update_imageString

The S3 URI points to a firmware update image that is to be used with a FUOTA task.

Returns:

  • (String)


640
641
642
643
644
645
646
647
648
649
650
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 640

class CreateFuotaTaskRequest < Struct.new(
  :name,
  :description,
  :client_request_token,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#firmware_update_roleString

The firmware update role that is to be used with a FUOTA task.

Returns:

  • (String)


640
641
642
643
644
645
646
647
648
649
650
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 640

class CreateFuotaTaskRequest < Struct.new(
  :name,
  :description,
  :client_request_token,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#lo_ra_wanTypes::LoRaWANFuotaTask

The LoRaWAN information used with a FUOTA task.



640
641
642
643
644
645
646
647
648
649
650
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 640

class CreateFuotaTaskRequest < Struct.new(
  :name,
  :description,
  :client_request_token,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of a FUOTA task.

Returns:

  • (String)


640
641
642
643
644
645
646
647
648
649
650
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 640

class CreateFuotaTaskRequest < Struct.new(
  :name,
  :description,
  :client_request_token,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :tags)
  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:



640
641
642
643
644
645
646
647
648
649
650
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 640

class CreateFuotaTaskRequest < Struct.new(
  :name,
  :description,
  :client_request_token,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end