aws.sagemaker.DeviceFleet
Explore with Pulumi AI
Provides a SageMaker 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", {
deviceFleetName: "example",
roleArn: test.arn,
outputConfig: {
s3OutputLocation: `s3://${exampleAwsS3Bucket.bucket}/prefix/`,
},
});
import pulumi
import pulumi_aws as aws
example = aws.sagemaker.DeviceFleet("example",
device_fleet_name="example",
role_arn=test["arn"],
output_config={
"s3_output_location": f"s3://{example_aws_s3_bucket['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(test.Arn),
OutputConfig: &sagemaker.DeviceFleetOutputConfigArgs{
S3OutputLocation: pulumi.Sprintf("s3://%v/prefix/", exampleAwsS3Bucket.Bucket),
},
})
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.DeviceFleet("example", new()
{
DeviceFleetName = "example",
RoleArn = test.Arn,
OutputConfig = new Aws.Sagemaker.Inputs.DeviceFleetOutputConfigArgs
{
S3OutputLocation = $"s3://{exampleAwsS3Bucket.Bucket}/prefix/",
},
});
});
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(test.arn())
.outputConfig(DeviceFleetOutputConfigArgs.builder()
.s3OutputLocation(String.format("s3://%s/prefix/", exampleAwsS3Bucket.bucket()))
.build())
.build());
}
}
resources:
example:
type: aws:sagemaker:DeviceFleet
properties:
deviceFleetName: example
roleArn: ${test.arn}
outputConfig:
s3OutputLocation: s3://${exampleAwsS3Bucket.bucket}/prefix/
Create DeviceFleet Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DeviceFleet(name: string, args: DeviceFleetArgs, opts?: CustomResourceOptions);
@overload
def DeviceFleet(resource_name: str,
args: DeviceFleetArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DeviceFleet(resource_name: str,
opts: Optional[ResourceOptions] = None,
device_fleet_name: Optional[str] = None,
output_config: Optional[DeviceFleetOutputConfigArgs] = None,
role_arn: Optional[str] = None,
description: Optional[str] = None,
enable_iot_role_alias: Optional[bool] = None,
tags: Optional[Mapping[str, str]] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var deviceFleetResource = new Aws.Sagemaker.DeviceFleet("deviceFleetResource", new()
{
DeviceFleetName = "string",
OutputConfig = new Aws.Sagemaker.Inputs.DeviceFleetOutputConfigArgs
{
S3OutputLocation = "string",
KmsKeyId = "string",
},
RoleArn = "string",
Description = "string",
EnableIotRoleAlias = false,
Tags =
{
{ "string", "string" },
},
});
example, err := sagemaker.NewDeviceFleet(ctx, "deviceFleetResource", &sagemaker.DeviceFleetArgs{
DeviceFleetName: pulumi.String("string"),
OutputConfig: &sagemaker.DeviceFleetOutputConfigArgs{
S3OutputLocation: pulumi.String("string"),
KmsKeyId: pulumi.String("string"),
},
RoleArn: pulumi.String("string"),
Description: pulumi.String("string"),
EnableIotRoleAlias: pulumi.Bool(false),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var deviceFleetResource = new DeviceFleet("deviceFleetResource", DeviceFleetArgs.builder()
.deviceFleetName("string")
.outputConfig(DeviceFleetOutputConfigArgs.builder()
.s3OutputLocation("string")
.kmsKeyId("string")
.build())
.roleArn("string")
.description("string")
.enableIotRoleAlias(false)
.tags(Map.of("string", "string"))
.build());
device_fleet_resource = aws.sagemaker.DeviceFleet("deviceFleetResource",
device_fleet_name="string",
output_config={
"s3_output_location": "string",
"kms_key_id": "string",
},
role_arn="string",
description="string",
enable_iot_role_alias=False,
tags={
"string": "string",
})
const deviceFleetResource = new aws.sagemaker.DeviceFleet("deviceFleetResource", {
deviceFleetName: "string",
outputConfig: {
s3OutputLocation: "string",
kmsKeyId: "string",
},
roleArn: "string",
description: "string",
enableIotRoleAlias: false,
tags: {
string: "string",
},
});
type: aws:sagemaker:DeviceFleet
properties:
description: string
deviceFleetName: string
enableIotRoleAlias: false
outputConfig:
kmsKeyId: string
s3OutputLocation: string
roleArn: string
tags:
string: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DeviceFleet resource accepts the following input properties:
- Device
Fleet stringName - The name of the Device Fleet (must be unique).
- Output
Config DeviceFleet Output Config - Specifies details about the repository. see Output Config details below.
- Role
Arn string - The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT).
- Description string
- A description of the fleet.
- Enable
Iot boolRole Alias - 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}".
- 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.
- Device
Fleet stringName - The name of the Device Fleet (must be unique).
- Output
Config DeviceFleet Output Config Args - Specifies details about the repository. see Output Config details below.
- Role
Arn string - The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT).
- Description string
- A description of the fleet.
- Enable
Iot boolRole Alias - 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}".
- 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.
- device
Fleet StringName - The name of the Device Fleet (must be unique).
- output
Config DeviceFleet Output Config - Specifies details about the repository. see Output Config details below.
- role
Arn String - The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT).
- description String
- A description of the fleet.
- enable
Iot BooleanRole Alias - 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}".
- 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.
- device
Fleet stringName - The name of the Device Fleet (must be unique).
- output
Config DeviceFleet Output Config - Specifies details about the repository. see Output Config details below.
- role
Arn string - The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT).
- description string
- A description of the fleet.
- enable
Iot booleanRole Alias - 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}".
- {[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_ strname - The name of the Device Fleet (must be unique).
- output_
config DeviceFleet Output Config Args - 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_ boolrole_ alias - 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}".
- 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.
- device
Fleet StringName - The name of the Device Fleet (must be unique).
- output
Config Property Map - Specifies details about the repository. see Output Config details below.
- role
Arn String - The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT).
- description String
- A description of the fleet.
- enable
Iot BooleanRole Alias - 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}".
- 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.
- Iot
Role stringAlias - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- 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.
- Iot
Role stringAlias - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- 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.
- iot
Role StringAlias - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- 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.
- iot
Role stringAlias - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- 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_ stralias - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- 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.
- iot
Role StringAlias - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
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.
- Arn string
- The Amazon Resource Name (ARN) assigned by AWS to this Device Fleet.
- Description string
- A description of the fleet.
- Device
Fleet stringName - The name of the Device Fleet (must be unique).
- Enable
Iot boolRole Alias - 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 stringAlias - Output
Config DeviceFleet Output Config - Specifies details about the repository. see Output Config details below.
- Role
Arn string - The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT).
- 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. - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Arn string
- The Amazon Resource Name (ARN) assigned by AWS to this Device Fleet.
- Description string
- A description of the fleet.
- Device
Fleet stringName - The name of the Device Fleet (must be unique).
- Enable
Iot boolRole Alias - 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 stringAlias - Output
Config DeviceFleet Output Config Args - Specifies details about the repository. see Output Config details below.
- Role
Arn string - The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT).
- 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. - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- The Amazon Resource Name (ARN) assigned by AWS to this Device Fleet.
- description String
- A description of the fleet.
- device
Fleet StringName - The name of the Device Fleet (must be unique).
- enable
Iot BooleanRole Alias - 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 StringAlias - output
Config DeviceFleet Output Config - Specifies details about the repository. see Output Config details below.
- role
Arn String - The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT).
- 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. - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn string
- The Amazon Resource Name (ARN) assigned by AWS to this Device Fleet.
- description string
- A description of the fleet.
- device
Fleet stringName - The name of the Device Fleet (must be unique).
- enable
Iot booleanRole Alias - 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 stringAlias - output
Config DeviceFleet Output Config - Specifies details about the repository. see Output Config details below.
- role
Arn string - The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT).
- {[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. - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn str
- The Amazon Resource Name (ARN) assigned by AWS to this Device Fleet.
- description str
- A description of the fleet.
- device_
fleet_ strname - The name of the Device Fleet (must be unique).
- enable_
iot_ boolrole_ alias - 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_ stralias - output_
config DeviceFleet Output Config Args - 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).
- 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. - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- The Amazon Resource Name (ARN) assigned by AWS to this Device Fleet.
- description String
- A description of the fleet.
- device
Fleet StringName - The name of the Device Fleet (must be unique).
- enable
Iot BooleanRole Alias - 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 StringAlias - output
Config Property Map - Specifies details about the repository. see Output Config details below.
- role
Arn String - The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT).
- 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. - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
Supporting Types
DeviceFleetOutputConfig, DeviceFleetOutputConfigArgs
- S3Output
Location string - The Amazon Simple Storage (S3) bucker URI.
- Kms
Key stringId - 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.
- S3Output
Location string - The Amazon Simple Storage (S3) bucker URI.
- Kms
Key stringId - 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.
- s3Output
Location String - The Amazon Simple Storage (S3) bucker URI.
- kms
Key StringId - 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.
- s3Output
Location string - The Amazon Simple Storage (S3) bucker URI.
- kms
Key stringId - 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_ strlocation - The Amazon Simple Storage (S3) bucker URI.
- kms_
key_ strid - 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.
- s3Output
Location String - The Amazon Simple Storage (S3) bucker URI.
- kms
Key StringId - 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
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.