AWS Cloud Control v1.9.0, Nov 18 24

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.sagemaker.Image

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

Create Image Resource

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

Constructor syntax

new Image(name: string, args: ImageArgs, opts?: CustomResourceOptions);

@overload
def Image(resource_name: str,
          args: ImageArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Image(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          image_role_arn: Optional[str] = None,
          image_description: Optional[str] = None,
          image_display_name: Optional[str] = None,
          image_name: Optional[str] = None,
          tags: Optional[Sequence[_root_inputs.TagArgs]] = None)

func NewImage(ctx *Context, name string, args ImageArgs, opts ...ResourceOption) (*Image, error)

public Image(string name, ImageArgs args, CustomResourceOptions? opts = null)

public Image(String name, ImageArgs args)
public Image(String name, ImageArgs args, CustomResourceOptions options)

type: aws-native:sagemaker:Image
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 ImageArgs: 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 ImageArgs: 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 ImageArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ImageArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ImageArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Image 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 Image resource accepts the following input properties:

ImageRoleArn string

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

Length Constraints : Minimum length of 20. Maximum length of 2048.

Pattern : ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

ImageDescription string

The description of the image.

ImageDisplayName string

The display name of the image.

Length Constraints : Minimum length of 1. Maximum length of 128.

Pattern : ^\S(.*\S)?$

ImageName string

The name of the Image. Must be unique by region in your account.

Length Constraints : Minimum length of 1. Maximum length of 63.

Pattern : ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$

Tags List<Pulumi.AwsNative.Inputs.Tag>

An array of key-value pairs to apply to this resource.

ImageRoleArn string

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

Length Constraints : Minimum length of 20. Maximum length of 2048.

Pattern : ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

ImageDescription string

The description of the image.

ImageDisplayName string

The display name of the image.

Length Constraints : Minimum length of 1. Maximum length of 128.

Pattern : ^\S(.*\S)?$

ImageName string

The name of the Image. Must be unique by region in your account.

Length Constraints : Minimum length of 1. Maximum length of 63.

Pattern : ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$

Tags TagArgs

An array of key-value pairs to apply to this resource.

imageRoleArn String

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

Length Constraints : Minimum length of 20. Maximum length of 2048.

Pattern : ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

imageDescription String

The description of the image.

imageDisplayName String

The display name of the image.

Length Constraints : Minimum length of 1. Maximum length of 128.

Pattern : ^\S(.*\S)?$

imageName String

The name of the Image. Must be unique by region in your account.

Length Constraints : Minimum length of 1. Maximum length of 63.

Pattern : ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$

tags List<Tag>

An array of key-value pairs to apply to this resource.

imageRoleArn string

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

Length Constraints : Minimum length of 20. Maximum length of 2048.

Pattern : ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

imageDescription string

The description of the image.

imageDisplayName string

The display name of the image.

Length Constraints : Minimum length of 1. Maximum length of 128.

Pattern : ^\S(.*\S)?$

imageName string

The name of the Image. Must be unique by region in your account.

Length Constraints : Minimum length of 1. Maximum length of 63.

Pattern : ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$

tags Tag[]

An array of key-value pairs to apply to this resource.

image_role_arn str

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

Length Constraints : Minimum length of 20. Maximum length of 2048.

Pattern : ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

image_description str

The description of the image.

image_display_name str

The display name of the image.

Length Constraints : Minimum length of 1. Maximum length of 128.

Pattern : ^\S(.*\S)?$

image_name str

The name of the Image. Must be unique by region in your account.

Length Constraints : Minimum length of 1. Maximum length of 63.

Pattern : ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$

tags Sequence[TagArgs]

An array of key-value pairs to apply to this resource.

imageRoleArn String

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

Length Constraints : Minimum length of 20. Maximum length of 2048.

Pattern : ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

imageDescription String

The description of the image.

imageDisplayName String

The display name of the image.

Length Constraints : Minimum length of 1. Maximum length of 128.

Pattern : ^\S(.*\S)?$

imageName String

The name of the Image. Must be unique by region in your account.

Length Constraints : Minimum length of 1. Maximum length of 63.

Pattern : ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$

tags List<Property Map>

An array of key-value pairs to apply to this resource.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

ImageArn string

The Amazon Resource Name (ARN) of the image.

Type : String

Length Constraints : Maximum length of 256.

Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$

Id string

The provider-assigned unique ID for this managed resource.

ImageArn string

The Amazon Resource Name (ARN) of the image.

Type : String

Length Constraints : Maximum length of 256.

Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$

id String

The provider-assigned unique ID for this managed resource.

imageArn String

The Amazon Resource Name (ARN) of the image.

Type : String

Length Constraints : Maximum length of 256.

Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$

id string

The provider-assigned unique ID for this managed resource.

imageArn string

The Amazon Resource Name (ARN) of the image.

Type : String

Length Constraints : Maximum length of 256.

Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$

id str

The provider-assigned unique ID for this managed resource.

image_arn str

The Amazon Resource Name (ARN) of the image.

Type : String

Length Constraints : Maximum length of 256.

Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$

id String

The provider-assigned unique ID for this managed resource.

imageArn String

The Amazon Resource Name (ARN) of the image.

Type : String

Length Constraints : Maximum length of 256.

Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$

Supporting Types

Tag, TagArgs

Key string: The key name of the tag
Value string: The value of the tag

Key string: The key name of the tag
Value string: The value of the tag

key String: The key name of the tag
value String: The value of the tag

key string: The key name of the tag
value string: The value of the tag

key str: The key name of the tag
value str: The value of the tag

key String: The key name of the tag
value String: The value of the tag

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.sagemaker.Image

On this page

On this page

Create Image Resource

Constructor syntax

Parameters

Image Resource Properties

Inputs

Outputs

Supporting Types

Tag, TagArgs

Package Details

On this page

On this page