DeviceFleet class

Provides a SageMaker AI Device Fleet resource.

Example Usage

Basic usage

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

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

example = aws.sagemaker.DeviceFleet("example",
    output_config={
        "s3_output_location": f"s3://{example_aws_s3_bucket['bucket']}/prefix/",
    },
    device_fleet_name="example",
    role_arn=test["arn"])
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()
    {
        OutputConfig = new Aws.Sagemaker.Inputs.DeviceFleetOutputConfigArgs
        {
            S3OutputLocation = $"s3://{exampleAwsS3Bucket.Bucket}/prefix/",
        },
        DeviceFleetName = "example",
        RoleArn = test.Arn,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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{
			OutputConfig: &sagemaker.DeviceFleetOutputConfigArgs{
				S3OutputLocation: pulumi.Sprintf("s3://%v/prefix/", exampleAwsS3Bucket.Bucket),
			},
			DeviceFleetName: pulumi.String("example"),
			RoleArn:         pulumi.Any(test.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_sagemaker_devicefleet" "example" {
  output_config = {
    s3_output_location ="s3://${exampleAwsS3Bucket.bucket}/prefix/"
  }
  device_fleet_name = "example"
  role_arn          = test.arn
}
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.ArrayList;
import java.util.Arrays;
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()
            .outputConfig(DeviceFleetOutputConfigArgs.builder()
                .s3OutputLocation(String.format("s3://%s/prefix/", exampleAwsS3Bucket.bucket()))
                .build())
            .deviceFleetName("example")
            .roleArn(test.arn())
            .build());

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

Import

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

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

Constructors

DeviceFleet(String name, {DeviceFleetArgs? args, CustomResourceOptions? options})
Creates a new DeviceFleet. name The Pulumi resource name. args Arguments used to configure this DeviceFleet. The set of arguments for DeviceFleet. options Resource options controlling this resource's behavior.
DeviceFleet.reference(String urn)
Creates a typed reference to an existing DeviceFleet resource.

Properties

arn ↔ Output<String>
ARN assigned by AWS to this Device Fleet.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
description ↔ Output<String?>
A description of the fleet.
latefinal
deviceFleetName ↔ Output<String>
The name of the Device Fleet (must be unique).
latefinal
enableIotRoleAlias ↔ Output<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}".
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
iotRoleAlias ↔ Output<String>
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
outputConfig ↔ Output<DeviceFleetOutputConfig>
Specifies details about the repository. see Output Config details below.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
roleArn ↔ Output<String>
ARN that has access to AWS Internet of Things (IoT).
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>
A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {DeviceFleetState? state, CustomResourceOptions? options}) → DeviceFleet
Gets an existing DeviceFleet resource's state with the given name and id.