Class: Aws::IoTWireless::Types::CreateDestinationRequest

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

{
  name: "DestinationName", # required
  expression_type: "RuleName", # required, accepts RuleName, MqttTopic
  expression: "Expression", # required
  description: "Description",
  role_arn: "RoleArn", # required
  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)


316
317
318
319
320
321
322
323
324
325
326
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 316

class CreateDestinationRequest < Struct.new(
  :name,
  :expression_type,
  :expression,
  :description,
  :role_arn,
  :tags,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the new resource.

Returns:

  • (String)


316
317
318
319
320
321
322
323
324
325
326
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 316

class CreateDestinationRequest < Struct.new(
  :name,
  :expression_type,
  :expression,
  :description,
  :role_arn,
  :tags,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#expressionString

The rule name or topic rule to send messages to.

Returns:

  • (String)


316
317
318
319
320
321
322
323
324
325
326
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 316

class CreateDestinationRequest < Struct.new(
  :name,
  :expression_type,
  :expression,
  :description,
  :role_arn,
  :tags,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#expression_typeString

The type of value in Expression.

Returns:

  • (String)


316
317
318
319
320
321
322
323
324
325
326
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 316

class CreateDestinationRequest < Struct.new(
  :name,
  :expression_type,
  :expression,
  :description,
  :role_arn,
  :tags,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the new resource.

Returns:

  • (String)


316
317
318
319
320
321
322
323
324
325
326
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 316

class CreateDestinationRequest < Struct.new(
  :name,
  :expression_type,
  :expression,
  :description,
  :role_arn,
  :tags,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

The ARN of the IAM Role that authorizes the destination.

Returns:

  • (String)


316
317
318
319
320
321
322
323
324
325
326
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 316

class CreateDestinationRequest < Struct.new(
  :name,
  :expression_type,
  :expression,
  :description,
  :role_arn,
  :tags,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

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

Returns:



316
317
318
319
320
321
322
323
324
325
326
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 316

class CreateDestinationRequest < Struct.new(
  :name,
  :expression_type,
  :expression,
  :description,
  :role_arn,
  :tags,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end