Class: Aws::SageMaker::Types::CreateDeviceFleetRequest

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

Overview

Note:

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

{
  device_fleet_name: "EntityName", # required
  role_arn: "RoleArn",
  description: "DeviceFleetDescription",
  output_config: { # required
    s3_output_location: "S3Uri", # required
    kms_key_id: "KmsKeyId",
    preset_deployment_type: "GreengrassV2Component", # accepts GreengrassV2Component
    preset_deployment_config: "String",
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  enable_iot_role_alias: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description of the fleet.

Returns:

  • (String)


5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5691

class CreateDeviceFleetRequest < Struct.new(
  :device_fleet_name,
  :role_arn,
  :description,
  :output_config,
  :tags,
  :enable_iot_role_alias)
  SENSITIVE = []
  include Aws::Structure
end

#device_fleet_nameString

The name of the fleet that the device belongs to.

Returns:

  • (String)


5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5691

class CreateDeviceFleetRequest < Struct.new(
  :device_fleet_name,
  :role_arn,
  :description,
  :output_config,
  :tags,
  :enable_iot_role_alias)
  SENSITIVE = []
  include Aws::Structure
end

#enable_iot_role_aliasBoolean

Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: "SageMakerEdge-{DeviceFleetName\}".

For example, if your device fleet is called "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet".

Returns:

  • (Boolean)


5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5691

class CreateDeviceFleetRequest < Struct.new(
  :device_fleet_name,
  :role_arn,
  :description,
  :output_config,
  :tags,
  :enable_iot_role_alias)
  SENSITIVE = []
  include Aws::Structure
end

#output_configTypes::EdgeOutputConfig

The output configuration for storing sample data collected by the fleet.



5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5691

class CreateDeviceFleetRequest < Struct.new(
  :device_fleet_name,
  :role_arn,
  :description,
  :output_config,
  :tags,
  :enable_iot_role_alias)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).

Returns:

  • (String)


5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5691

class CreateDeviceFleetRequest < Struct.new(
  :device_fleet_name,
  :role_arn,
  :description,
  :output_config,
  :tags,
  :enable_iot_role_alias)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

Creates tags for the specified fleet.

Returns:



5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5691

class CreateDeviceFleetRequest < Struct.new(
  :device_fleet_name,
  :role_arn,
  :description,
  :output_config,
  :tags,
  :enable_iot_role_alias)
  SENSITIVE = []
  include Aws::Structure
end