@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
201 lines (200 loc) • 8.47 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides a SageMaker AI App Image Config resource.
*
* ## Example Usage
*
* ### Basic usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const test = new aws.sagemaker.AppImageConfig("test", {
* appImageConfigName: "example",
* kernelGatewayImageConfig: {
* kernelSpecs: [{
* name: "example",
* }],
* },
* });
* ```
*
* ### Using Code Editor with empty configuration
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const test = new aws.sagemaker.AppImageConfig("test", {
* appImageConfigName: "example",
* codeEditorAppImageConfig: {},
* });
* ```
*
* ### Default File System Config
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const test = new aws.sagemaker.AppImageConfig("test", {
* appImageConfigName: "example",
* kernelGatewayImageConfig: {
* kernelSpecs: [{
* name: "example",
* }],
* fileSystemConfig: {},
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import SageMaker AI App Image Configs using the `name`. For example:
*
* ```sh
* $ pulumi import aws:sagemaker/appImageConfig:AppImageConfig example example
* ```
*/
export declare class AppImageConfig extends pulumi.CustomResource {
/**
* Get an existing AppImageConfig resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AppImageConfigState, opts?: pulumi.CustomResourceOptions): AppImageConfig;
/**
* Returns true if the given object is an instance of AppImageConfig. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is AppImageConfig;
/**
* The name of the App Image Config.
*/
readonly appImageConfigName: pulumi.Output<string>;
/**
* The Amazon Resource Name (ARN) assigned by AWS to this App Image Config.
*/
readonly arn: pulumi.Output<string>;
/**
* The CodeEditorAppImageConfig. See Code Editor App Image Config details below.
*/
readonly codeEditorAppImageConfig: pulumi.Output<outputs.sagemaker.AppImageConfigCodeEditorAppImageConfig | undefined>;
/**
* The JupyterLabAppImageConfig. See Jupyter Lab Image Config details below.
*/
readonly jupyterLabImageConfig: pulumi.Output<outputs.sagemaker.AppImageConfigJupyterLabImageConfig | undefined>;
/**
* The configuration for the file system and kernels in a SageMaker AI image running as a KernelGateway app. See Kernel Gateway Image Config details below.
*/
readonly kernelGatewayImageConfig: pulumi.Output<outputs.sagemaker.AppImageConfigKernelGatewayImageConfig | undefined>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<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.
*
* > **NOTE:** Exactly one of `codeEditorAppImageConfig`, `jupyterLabImageConfig`, or `kernelGatewayImageConfig` must be configured. Empty blocks (e.g., `codeEditorAppImageConfig {}`) are valid configurations.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a AppImageConfig resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: AppImageConfigArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AppImageConfig resources.
*/
export interface AppImageConfigState {
/**
* The name of the App Image Config.
*/
appImageConfigName?: pulumi.Input<string>;
/**
* The Amazon Resource Name (ARN) assigned by AWS to this App Image Config.
*/
arn?: pulumi.Input<string>;
/**
* The CodeEditorAppImageConfig. See Code Editor App Image Config details below.
*/
codeEditorAppImageConfig?: pulumi.Input<inputs.sagemaker.AppImageConfigCodeEditorAppImageConfig>;
/**
* The JupyterLabAppImageConfig. See Jupyter Lab Image Config details below.
*/
jupyterLabImageConfig?: pulumi.Input<inputs.sagemaker.AppImageConfigJupyterLabImageConfig>;
/**
* The configuration for the file system and kernels in a SageMaker AI image running as a KernelGateway app. See Kernel Gateway Image Config details below.
*/
kernelGatewayImageConfig?: pulumi.Input<inputs.sagemaker.AppImageConfigKernelGatewayImageConfig>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<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.
*
* > **NOTE:** Exactly one of `codeEditorAppImageConfig`, `jupyterLabImageConfig`, or `kernelGatewayImageConfig` must be configured. Empty blocks (e.g., `codeEditorAppImageConfig {}`) are valid configurations.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}
/**
* The set of arguments for constructing a AppImageConfig resource.
*/
export interface AppImageConfigArgs {
/**
* The name of the App Image Config.
*/
appImageConfigName: pulumi.Input<string>;
/**
* The CodeEditorAppImageConfig. See Code Editor App Image Config details below.
*/
codeEditorAppImageConfig?: pulumi.Input<inputs.sagemaker.AppImageConfigCodeEditorAppImageConfig>;
/**
* The JupyterLabAppImageConfig. See Jupyter Lab Image Config details below.
*/
jupyterLabImageConfig?: pulumi.Input<inputs.sagemaker.AppImageConfigJupyterLabImageConfig>;
/**
* The configuration for the file system and kernels in a SageMaker AI image running as a KernelGateway app. See Kernel Gateway Image Config details below.
*/
kernelGatewayImageConfig?: pulumi.Input<inputs.sagemaker.AppImageConfigKernelGatewayImageConfig>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<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.
*
* > **NOTE:** Exactly one of `codeEditorAppImageConfig`, `jupyterLabImageConfig`, or `kernelGatewayImageConfig` must be configured. Empty blocks (e.g., `codeEditorAppImageConfig {}`) are valid configurations.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}