Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. sagemaker
  5. Device
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.sagemaker.Device

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Provides a SageMaker Device resource.

    Example Usage

    Basic usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.sagemaker.Device("example", {
    deviceFleetName: exampleAwsSagemakerDeviceFleet.deviceFleetName,
    device: {
        deviceName: "example",
    },
});

    import pulumi
import pulumi_aws as aws

example = aws.sagemaker.Device("example",
    device_fleet_name=example_aws_sagemaker_device_fleet["deviceFleetName"],
    device={
        "device_name": "example",
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sagemaker"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sagemaker.NewDevice(ctx, "example", &sagemaker.DeviceArgs{
			DeviceFleetName: pulumi.Any(exampleAwsSagemakerDeviceFleet.DeviceFleetName),
			Device: &sagemaker.DeviceDeviceArgs{
				DeviceName: pulumi.String("example"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Sagemaker.Device("example", new()
    {
        DeviceFleetName = exampleAwsSagemakerDeviceFleet.DeviceFleetName,
        DeviceDetails = new Aws.Sagemaker.Inputs.DeviceDeviceArgs
        {
            DeviceName = "example",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sagemaker.Device;
import com.pulumi.aws.sagemaker.DeviceArgs;
import com.pulumi.aws.sagemaker.inputs.DeviceDeviceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Device("example", DeviceArgs.builder()
            .deviceFleetName(exampleAwsSagemakerDeviceFleet.deviceFleetName())
            .device(DeviceDeviceArgs.builder()
                .deviceName("example")
                .build())
            .build());

    }
}

    resources:
  example:
    type: aws:sagemaker:Device
    properties:
      deviceFleetName: ${exampleAwsSagemakerDeviceFleet.deviceFleetName}
      device:
        deviceName: example

    Create Device Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Device(name: string, args: DeviceArgs, opts?: CustomResourceOptions);
    @overload
def Device(resource_name: str,
           args: DeviceArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Device(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           device: Optional[DeviceDeviceArgs] = None,
           device_fleet_name: Optional[str] = None)
    func NewDevice(ctx *Context, name string, args DeviceArgs, opts ...ResourceOption) (*Device, error)
    public Device(string name, DeviceArgs args, CustomResourceOptions? opts = null)
    public Device(String name, DeviceArgs args)
public Device(String name, DeviceArgs args, CustomResourceOptions options)

    type: aws:sagemaker:Device
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args DeviceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DeviceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DeviceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DeviceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DeviceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var awsDeviceResource = new Aws.Sagemaker.Device("awsDeviceResource", new()
{
    DeviceDetails = new Aws.Sagemaker.Inputs.DeviceDeviceArgs
    {
        DeviceName = "string",
        Description = "string",
        IotThingName = "string",
    },
    DeviceFleetName = "string",
});

    example, err := sagemaker.NewDevice(ctx, "awsDeviceResource", &sagemaker.DeviceArgs{
	Device: &sagemaker.DeviceDeviceArgs{
		DeviceName:   pulumi.String("string"),
		Description:  pulumi.String("string"),
		IotThingName: pulumi.String("string"),
	},
	DeviceFleetName: pulumi.String("string"),
})

    var awsDeviceResource = new Device("awsDeviceResource", DeviceArgs.builder()
    .device(DeviceDeviceArgs.builder()
        .deviceName("string")
        .description("string")
        .iotThingName("string")
        .build())
    .deviceFleetName("string")
    .build());

    aws_device_resource = aws.sagemaker.Device("awsDeviceResource",
    device={
        "device_name": "string",
        "description": "string",
        "iot_thing_name": "string",
    },
    device_fleet_name="string")

    const awsDeviceResource = new aws.sagemaker.Device("awsDeviceResource", {
    device: {
        deviceName: "string",
        description: "string",
        iotThingName: "string",
    },
    deviceFleetName: "string",
});

    type: aws:sagemaker:Device
properties:
    device:
        description: string
        deviceName: string
        iotThingName: string
    deviceFleetName: string

    Device Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Device resource accepts the following input properties:

    DeviceDetails DeviceDevice
    The device to register with SageMaker Edge Manager. See Device details below.
    DeviceFleetName string
    The name of the Device Fleet.
    Device DeviceDeviceArgs
    The device to register with SageMaker Edge Manager. See Device details below.
    DeviceFleetName string
    The name of the Device Fleet.
    device DeviceDevice
    The device to register with SageMaker Edge Manager. See Device details below.
    deviceFleetName String
    The name of the Device Fleet.
    device DeviceDevice
    The device to register with SageMaker Edge Manager. See Device details below.
    deviceFleetName string
    The name of the Device Fleet.
    device DeviceDeviceArgs
    The device to register with SageMaker Edge Manager. See Device details below.
    device_fleet_name str
    The name of the Device Fleet.
    device Property Map
    The device to register with SageMaker Edge Manager. See Device details below.
    deviceFleetName String
    The name of the Device Fleet.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Device resource produces the following output properties:

    AgentVersion string
    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Device.
    Id string
    The provider-assigned unique ID for this managed resource.
    AgentVersion string
    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Device.
    Id string
    The provider-assigned unique ID for this managed resource.
    agentVersion String
    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Device.
    id String
    The provider-assigned unique ID for this managed resource.
    agentVersion string
    arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Device.
    id string
    The provider-assigned unique ID for this managed resource.
    agent_version str
    arn str
    The Amazon Resource Name (ARN) assigned by AWS to this Device.
    id str
    The provider-assigned unique ID for this managed resource.
    agentVersion String
    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Device.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Device Resource

    Get an existing Device resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DeviceState, opts?: CustomResourceOptions): Device
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        agent_version: Optional[str] = None,
        arn: Optional[str] = None,
        device: Optional[DeviceDeviceArgs] = None,
        device_fleet_name: Optional[str] = None) -> Device
    func GetDevice(ctx *Context, name string, id IDInput, state *DeviceState, opts ...ResourceOption) (*Device, error)
    public static Device Get(string name, Input<string> id, DeviceState? state, CustomResourceOptions? opts = null)
    public static Device get(String name, Output<String> id, DeviceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AgentVersion string
    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Device.
    DeviceDetails DeviceDevice
    The device to register with SageMaker Edge Manager. See Device details below.
    DeviceFleetName string
    The name of the Device Fleet.
    AgentVersion string
    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Device.
    Device DeviceDeviceArgs
    The device to register with SageMaker Edge Manager. See Device details below.
    DeviceFleetName string
    The name of the Device Fleet.
    agentVersion String
    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Device.
    device DeviceDevice
    The device to register with SageMaker Edge Manager. See Device details below.
    deviceFleetName String
    The name of the Device Fleet.
    agentVersion string
    arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Device.
    device DeviceDevice
    The device to register with SageMaker Edge Manager. See Device details below.
    deviceFleetName string
    The name of the Device Fleet.
    agent_version str
    arn str
    The Amazon Resource Name (ARN) assigned by AWS to this Device.
    device DeviceDeviceArgs
    The device to register with SageMaker Edge Manager. See Device details below.
    device_fleet_name str
    The name of the Device Fleet.
    agentVersion String
    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Device.
    device Property Map
    The device to register with SageMaker Edge Manager. See Device details below.
    deviceFleetName String
    The name of the Device Fleet.

    Supporting Types

    DeviceDevice, DeviceDeviceArgs

    DeviceName string
    The name of the device.
    Description string
    A description for the device.
    IotThingName string
    Amazon Web Services Internet of Things (IoT) object name.
    DeviceName string
    The name of the device.
    Description string
    A description for the device.
    IotThingName string
    Amazon Web Services Internet of Things (IoT) object name.
    deviceName String
    The name of the device.
    description String
    A description for the device.
    iotThingName String
    Amazon Web Services Internet of Things (IoT) object name.
    deviceName string
    The name of the device.
    description string
    A description for the device.
    iotThingName string
    Amazon Web Services Internet of Things (IoT) object name.
    device_name str
    The name of the device.
    description str
    A description for the device.
    iot_thing_name str
    Amazon Web Services Internet of Things (IoT) object name.
    deviceName String
    The name of the device.
    description String
    A description for the device.
    iotThingName String
    Amazon Web Services Internet of Things (IoT) object name.

    Import

    Using pulumi import, import SageMaker Devices using the device-fleet-name/device-name. For example:

    $ pulumi import aws:sagemaker/device:Device example my-fleet/my-device

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws