Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. sagemaker
  5. DeviceFleet

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.13.0 published on Saturday, Dec 2, 2023 by Pulumi
pulumi/pulumi-aws

aws.sagemaker.DeviceFleet

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.13.0 published on Saturday, Dec 2, 2023 by Pulumi
pulumi/pulumi-aws

    Provides a SageMaker Device Fleet resource.

    Example Usage

    Basic usage

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

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Sagemaker.DeviceFleet("example", new()
    {
        DeviceFleetName = "example",
        RoleArn = aws_iam_role.Test.Arn,
        OutputConfig = new Aws.Sagemaker.Inputs.DeviceFleetOutputConfigArgs
        {
            S3OutputLocation = $"s3://{aws_s3_bucket.Example.Bucket}/prefix/",
        },
    });

});

    package main

import (
	"fmt"

	"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.NewDeviceFleet(ctx, "example", &sagemaker.DeviceFleetArgs{
			DeviceFleetName: pulumi.String("example"),
			RoleArn:         pulumi.Any(aws_iam_role.Test.Arn),
			OutputConfig: &sagemaker.DeviceFleetOutputConfigArgs{
				S3OutputLocation: pulumi.String(fmt.Sprintf("s3://%v/prefix/", aws_s3_bucket.Example.Bucket)),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sagemaker.DeviceFleet;
import com.pulumi.aws.sagemaker.DeviceFleetArgs;
import com.pulumi.aws.sagemaker.inputs.DeviceFleetOutputConfigArgs;
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 DeviceFleet("example", DeviceFleetArgs.builder()        
            .deviceFleetName("example")
            .roleArn(aws_iam_role.test().arn())
            .outputConfig(DeviceFleetOutputConfigArgs.builder()
                .s3OutputLocation(String.format("s3://%s/prefix/", aws_s3_bucket.example().bucket()))
                .build())
            .build());

    }
}

    import pulumi
import pulumi_aws as aws

example = aws.sagemaker.DeviceFleet("example",
    device_fleet_name="example",
    role_arn=aws_iam_role["test"]["arn"],
    output_config=aws.sagemaker.DeviceFleetOutputConfigArgs(
        s3_output_location=f"s3://{aws_s3_bucket['example']['bucket']}/prefix/",
    ))

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

const example = new aws.sagemaker.DeviceFleet("example", {
    deviceFleetName: "example",
    roleArn: aws_iam_role.test.arn,
    outputConfig: {
        s3OutputLocation: `s3://${aws_s3_bucket.example.bucket}/prefix/`,
    },
});

    resources:
  example:
    type: aws:sagemaker:DeviceFleet
    properties:
      deviceFleetName: example
      roleArn: ${aws_iam_role.test.arn}
      outputConfig:
        s3OutputLocation: s3://${aws_s3_bucket.example.bucket}/prefix/

    Create DeviceFleet Resource

    new DeviceFleet(name: string, args: DeviceFleetArgs, opts?: CustomResourceOptions);
    @overload
def DeviceFleet(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                description: Optional[str] = None,
                device_fleet_name: Optional[str] = None,
                enable_iot_role_alias: Optional[bool] = None,
                output_config: Optional[DeviceFleetOutputConfigArgs] = None,
                role_arn: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None)
@overload
def DeviceFleet(resource_name: str,
                args: DeviceFleetArgs,
                opts: Optional[ResourceOptions] = None)
    func NewDeviceFleet(ctx *Context, name string, args DeviceFleetArgs, opts ...ResourceOption) (*DeviceFleet, error)
    public DeviceFleet(string name, DeviceFleetArgs args, CustomResourceOptions? opts = null)
    public DeviceFleet(String name, DeviceFleetArgs args)
public DeviceFleet(String name, DeviceFleetArgs args, CustomResourceOptions options)

    type: aws:sagemaker:DeviceFleet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DeviceFleetArgs
    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 DeviceFleetArgs
    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 DeviceFleetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DeviceFleetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DeviceFleetArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    DeviceFleet Resource Properties

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

    Inputs

    The DeviceFleet resource accepts the following input properties:

    DeviceFleetName string

    The name of the Device Fleet (must be unique).

    OutputConfig Pulumi.Aws.Sagemaker.Inputs.DeviceFleetOutputConfig

    Specifies details about the repository. see Output Config details below.

    RoleArn string

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

    Description string

    A description of the fleet.

    EnableIotRoleAlias bool

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

    Tags Dictionary<string, string>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    DeviceFleetName string

    The name of the Device Fleet (must be unique).

    OutputConfig DeviceFleetOutputConfigArgs

    Specifies details about the repository. see Output Config details below.

    RoleArn string

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

    Description string

    A description of the fleet.

    EnableIotRoleAlias bool

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

    Tags map[string]string

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    deviceFleetName String

    The name of the Device Fleet (must be unique).

    outputConfig DeviceFleetOutputConfig

    Specifies details about the repository. see Output Config details below.

    roleArn String

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

    description String

    A description of the fleet.

    enableIotRoleAlias Boolean

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

    tags Map<String,String>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    deviceFleetName string

    The name of the Device Fleet (must be unique).

    outputConfig DeviceFleetOutputConfig

    Specifies details about the repository. see Output Config details below.

    roleArn string

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

    description string

    A description of the fleet.

    enableIotRoleAlias boolean

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

    tags {[key: string]: string}

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    device_fleet_name str

    The name of the Device Fleet (must be unique).

    output_config DeviceFleetOutputConfigArgs

    Specifies details about the repository. see Output Config details below.

    role_arn str

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

    description str

    A description of the fleet.

    enable_iot_role_alias bool

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

    tags Mapping[str, str]

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    deviceFleetName String

    The name of the Device Fleet (must be unique).

    outputConfig Property Map

    Specifies details about the repository. see Output Config details below.

    roleArn String

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

    description String

    A description of the fleet.

    enableIotRoleAlias Boolean

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

    tags Map<String>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string

    The Amazon Resource Name (ARN) assigned by AWS to this Device Fleet.

    Id string

    The provider-assigned unique ID for this managed resource.

    IotRoleAlias string
    TagsAll Dictionary<string, string>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Arn string

    The Amazon Resource Name (ARN) assigned by AWS to this Device Fleet.

    Id string

    The provider-assigned unique ID for this managed resource.

    IotRoleAlias string
    TagsAll map[string]string

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn String

    The Amazon Resource Name (ARN) assigned by AWS to this Device Fleet.

    id String

    The provider-assigned unique ID for this managed resource.

    iotRoleAlias String
    tagsAll Map<String,String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn string

    The Amazon Resource Name (ARN) assigned by AWS to this Device Fleet.

    id string

    The provider-assigned unique ID for this managed resource.

    iotRoleAlias string
    tagsAll {[key: string]: string}

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn str

    The Amazon Resource Name (ARN) assigned by AWS to this Device Fleet.

    id str

    The provider-assigned unique ID for this managed resource.

    iot_role_alias str
    tags_all Mapping[str, str]

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn String

    The Amazon Resource Name (ARN) assigned by AWS to this Device Fleet.

    id String

    The provider-assigned unique ID for this managed resource.

    iotRoleAlias String
    tagsAll Map<String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Look up Existing DeviceFleet Resource

    Get an existing DeviceFleet 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?: DeviceFleetState, opts?: CustomResourceOptions): DeviceFleet
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        description: Optional[str] = None,
        device_fleet_name: Optional[str] = None,
        enable_iot_role_alias: Optional[bool] = None,
        iot_role_alias: Optional[str] = None,
        output_config: Optional[DeviceFleetOutputConfigArgs] = None,
        role_arn: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> DeviceFleet
    func GetDeviceFleet(ctx *Context, name string, id IDInput, state *DeviceFleetState, opts ...ResourceOption) (*DeviceFleet, error)
    public static DeviceFleet Get(string name, Input<string> id, DeviceFleetState? state, CustomResourceOptions? opts = null)
    public static DeviceFleet get(String name, Output<String> id, DeviceFleetState 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:
    Arn string

    The Amazon Resource Name (ARN) assigned by AWS to this Device Fleet.

    Description string

    A description of the fleet.

    DeviceFleetName string

    The name of the Device Fleet (must be unique).

    EnableIotRoleAlias bool

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

    IotRoleAlias string
    OutputConfig Pulumi.Aws.Sagemaker.Inputs.DeviceFleetOutputConfig

    Specifies details about the repository. see Output Config details below.

    RoleArn string

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

    Tags Dictionary<string, string>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    TagsAll Dictionary<string, string>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Arn string

    The Amazon Resource Name (ARN) assigned by AWS to this Device Fleet.

    Description string

    A description of the fleet.

    DeviceFleetName string

    The name of the Device Fleet (must be unique).

    EnableIotRoleAlias bool

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

    IotRoleAlias string
    OutputConfig DeviceFleetOutputConfigArgs

    Specifies details about the repository. see Output Config details below.

    RoleArn string

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

    Tags map[string]string

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    TagsAll map[string]string

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn String

    The Amazon Resource Name (ARN) assigned by AWS to this Device Fleet.

    description String

    A description of the fleet.

    deviceFleetName String

    The name of the Device Fleet (must be unique).

    enableIotRoleAlias Boolean

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

    iotRoleAlias String
    outputConfig DeviceFleetOutputConfig

    Specifies details about the repository. see Output Config details below.

    roleArn String

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

    tags Map<String,String>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll Map<String,String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn string

    The Amazon Resource Name (ARN) assigned by AWS to this Device Fleet.

    description string

    A description of the fleet.

    deviceFleetName string

    The name of the Device Fleet (must be unique).

    enableIotRoleAlias boolean

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

    iotRoleAlias string
    outputConfig DeviceFleetOutputConfig

    Specifies details about the repository. see Output Config details below.

    roleArn string

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

    tags {[key: string]: string}

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll {[key: string]: string}

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn str

    The Amazon Resource Name (ARN) assigned by AWS to this Device Fleet.

    description str

    A description of the fleet.

    device_fleet_name str

    The name of the Device Fleet (must be unique).

    enable_iot_role_alias bool

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

    iot_role_alias str
    output_config DeviceFleetOutputConfigArgs

    Specifies details about the repository. see Output Config details below.

    role_arn str

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

    tags Mapping[str, str]

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tags_all Mapping[str, str]

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    arn String

    The Amazon Resource Name (ARN) assigned by AWS to this Device Fleet.

    description String

    A description of the fleet.

    deviceFleetName String

    The name of the Device Fleet (must be unique).

    enableIotRoleAlias Boolean

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

    iotRoleAlias String
    outputConfig Property Map

    Specifies details about the repository. see Output Config details below.

    roleArn String

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

    tags Map<String>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll Map<String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Supporting Types

    DeviceFleetOutputConfig, DeviceFleetOutputConfigArgs

    S3OutputLocation string

    The Amazon Simple Storage (S3) bucker URI.

    KmsKeyId string

    The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.

    S3OutputLocation string

    The Amazon Simple Storage (S3) bucker URI.

    KmsKeyId string

    The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.

    s3OutputLocation String

    The Amazon Simple Storage (S3) bucker URI.

    kmsKeyId String

    The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.

    s3OutputLocation string

    The Amazon Simple Storage (S3) bucker URI.

    kmsKeyId string

    The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.

    s3_output_location str

    The Amazon Simple Storage (S3) bucker URI.

    kms_key_id str

    The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.

    s3OutputLocation String

    The Amazon Simple Storage (S3) bucker URI.

    kmsKeyId String

    The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.

    Import

    Using pulumi import, import SageMaker Device Fleets using the name. For example:

     $ pulumi import aws:sagemaker/deviceFleet:DeviceFleet example my-fleet

    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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.13.0 published on Saturday, Dec 2, 2023 by Pulumi
    pulumi/pulumi-aws