AWS Native is in preview. AWS Classic is fully supported.
aws-native.sagemaker.Image
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
Resource Type definition for AWS::SageMaker::Image
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)
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
The Image resource accepts the following input properties:
- Image
Role stringArn 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 string - The description of the image.
- Image
Display stringName The display name of the image.
Length Constraints : Minimum length of 1. Maximum length of 128.
Pattern :
^\S(.*\S)?$
- Image
Name 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}$
- List<Pulumi.
Aws Native. Inputs. Tag> - An array of key-value pairs to apply to this resource.
- Image
Role stringArn 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 string - The description of the image.
- Image
Display stringName The display name of the image.
Length Constraints : Minimum length of 1. Maximum length of 128.
Pattern :
^\S(.*\S)?$
- Image
Name 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}$
- Tag
Args - An array of key-value pairs to apply to this resource.
- image
Role StringArn 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 String - The description of the image.
- image
Display StringName The display name of the image.
Length Constraints : Minimum length of 1. Maximum length of 128.
Pattern :
^\S(.*\S)?$
- image
Name 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}$
- List<Tag>
- An array of key-value pairs to apply to this resource.
- image
Role stringArn 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 string - The description of the image.
- image
Display stringName The display name of the image.
Length Constraints : Minimum length of 1. Maximum length of 128.
Pattern :
^\S(.*\S)?$
- image
Name 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}$
- Tag[]
- An array of key-value pairs to apply to this resource.
- image_
role_ strarn 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_ strname 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}$
- Sequence[Tag
Args] - An array of key-value pairs to apply to this resource.
- image
Role StringArn 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 String - The description of the image.
- image
Display StringName The display name of the image.
Length Constraints : Minimum length of 1. Maximum length of 128.
Pattern :
^\S(.*\S)?$
- image
Name 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}$
- 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:
Supporting Types
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.