Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. sagemaker
  5. Hub
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.sagemaker.Hub

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Provides a SageMaker Hub resource.

    Example Usage

    Basic usage

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

const example = new aws.sagemaker.Hub("example", {
    hubName: "example",
    hubDescription: "example",
});

    import pulumi
import pulumi_aws as aws

example = aws.sagemaker.Hub("example",
    hub_name="example",
    hub_description="example")

    package main

import (
	"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.NewHub(ctx, "example", &sagemaker.HubArgs{
			HubName:        pulumi.String("example"),
			HubDescription: pulumi.String("example"),
		})
		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.Hub("example", new()
    {
        HubName = "example",
        HubDescription = "example",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sagemaker.Hub;
import com.pulumi.aws.sagemaker.HubArgs;
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 Hub("example", HubArgs.builder()
            .hubName("example")
            .hubDescription("example")
            .build());

    }
}

    resources:
  example:
    type: aws:sagemaker:Hub
    properties:
      hubName: example
      hubDescription: example

    Create Hub Resource

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

    Constructor syntax

    new Hub(name: string, args: HubArgs, opts?: CustomResourceOptions);
    @overload
def Hub(resource_name: str,
        args: HubArgs,
        opts: Optional[ResourceOptions] = None)

@overload
def Hub(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        hub_description: Optional[str] = None,
        hub_name: Optional[str] = None,
        hub_display_name: Optional[str] = None,
        hub_search_keywords: Optional[Sequence[str]] = None,
        s3_storage_config: Optional[HubS3StorageConfigArgs] = None,
        tags: Optional[Mapping[str, str]] = None)
    func NewHub(ctx *Context, name string, args HubArgs, opts ...ResourceOption) (*Hub, error)
    public Hub(string name, HubArgs args, CustomResourceOptions? opts = null)
    public Hub(String name, HubArgs args)
public Hub(String name, HubArgs args, CustomResourceOptions options)

    type: aws:sagemaker:Hub
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 HubArgs
    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 HubArgs
    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 HubArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HubArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HubArgs
    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 hubResource = new Aws.Sagemaker.Hub("hubResource", new()
{
    HubDescription = "string",
    HubName = "string",
    HubDisplayName = "string",
    HubSearchKeywords = new[]
    {
        "string",
    },
    S3StorageConfig = new Aws.Sagemaker.Inputs.HubS3StorageConfigArgs
    {
        S3OutputPath = "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := sagemaker.NewHub(ctx, "hubResource", &sagemaker.HubArgs{
	HubDescription: pulumi.String("string"),
	HubName:        pulumi.String("string"),
	HubDisplayName: pulumi.String("string"),
	HubSearchKeywords: pulumi.StringArray{
		pulumi.String("string"),
	},
	S3StorageConfig: &sagemaker.HubS3StorageConfigArgs{
		S3OutputPath: pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var hubResource = new Hub("hubResource", HubArgs.builder()
    .hubDescription("string")
    .hubName("string")
    .hubDisplayName("string")
    .hubSearchKeywords("string")
    .s3StorageConfig(HubS3StorageConfigArgs.builder()
        .s3OutputPath("string")
        .build())
    .tags(Map.of("string", "string"))
    .build());

    hub_resource = aws.sagemaker.Hub("hubResource",
    hub_description="string",
    hub_name="string",
    hub_display_name="string",
    hub_search_keywords=["string"],
    s3_storage_config={
        "s3_output_path": "string",
    },
    tags={
        "string": "string",
    })

    const hubResource = new aws.sagemaker.Hub("hubResource", {
    hubDescription: "string",
    hubName: "string",
    hubDisplayName: "string",
    hubSearchKeywords: ["string"],
    s3StorageConfig: {
        s3OutputPath: "string",
    },
    tags: {
        string: "string",
    },
});

    type: aws:sagemaker:Hub
properties:
    hubDescription: string
    hubDisplayName: string
    hubName: string
    hubSearchKeywords:
        - string
    s3StorageConfig:
        s3OutputPath: string
    tags:
        string: string

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

    HubDescription string
    A description of the hub.
    HubName string
    The name of the hub.
    HubDisplayName string
    The display name of the hub.
    HubSearchKeywords List<string>
    The searchable keywords for the hub.
    S3StorageConfig HubS3StorageConfig
    The Amazon S3 storage configuration for the hub. See S3 Storage Config details below.
    Tags 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.
    HubDescription string
    A description of the hub.
    HubName string
    The name of the hub.
    HubDisplayName string
    The display name of the hub.
    HubSearchKeywords []string
    The searchable keywords for the hub.
    S3StorageConfig HubS3StorageConfigArgs
    The Amazon S3 storage configuration for the hub. See S3 Storage Config details below.
    Tags 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.
    hubDescription String
    A description of the hub.
    hubName String
    The name of the hub.
    hubDisplayName String
    The display name of the hub.
    hubSearchKeywords List<String>
    The searchable keywords for the hub.
    s3StorageConfig HubS3StorageConfig
    The Amazon S3 storage configuration for the hub. See S3 Storage Config details below.
    tags 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.
    hubDescription string
    A description of the hub.
    hubName string
    The name of the hub.
    hubDisplayName string
    The display name of the hub.
    hubSearchKeywords string[]
    The searchable keywords for the hub.
    s3StorageConfig HubS3StorageConfig
    The Amazon S3 storage configuration for the hub. See S3 Storage Config details below.
    tags {[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.
    hub_description str
    A description of the hub.
    hub_name str
    The name of the hub.
    hub_display_name str
    The display name of the hub.
    hub_search_keywords Sequence[str]
    The searchable keywords for the hub.
    s3_storage_config HubS3StorageConfigArgs
    The Amazon S3 storage configuration for the hub. See S3 Storage Config details below.
    tags 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.
    hubDescription String
    A description of the hub.
    hubName String
    The name of the hub.
    hubDisplayName String
    The display name of the hub.
    hubSearchKeywords List<String>
    The searchable keywords for the hub.
    s3StorageConfig Property Map
    The Amazon S3 storage configuration for the hub. See S3 Storage Config details below.
    tags 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 Hub resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Hub.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Hub.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Hub.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Hub.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Amazon Resource Name (ARN) assigned by AWS to this Hub.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Hub.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Hub Resource

    Get an existing Hub 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?: HubState, opts?: CustomResourceOptions): Hub
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        hub_description: Optional[str] = None,
        hub_display_name: Optional[str] = None,
        hub_name: Optional[str] = None,
        hub_search_keywords: Optional[Sequence[str]] = None,
        s3_storage_config: Optional[HubS3StorageConfigArgs] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Hub
    func GetHub(ctx *Context, name string, id IDInput, state *HubState, opts ...ResourceOption) (*Hub, error)
    public static Hub Get(string name, Input<string> id, HubState? state, CustomResourceOptions? opts = null)
    public static Hub get(String name, Output<String> id, HubState 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.
    The following state arguments are supported:
    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Hub.
    HubDescription string
    A description of the hub.
    HubDisplayName string
    The display name of the hub.
    HubName string
    The name of the hub.
    HubSearchKeywords List<string>
    The searchable keywords for the hub.
    S3StorageConfig HubS3StorageConfig
    The Amazon S3 storage configuration for the hub. See S3 Storage Config details below.
    Tags 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.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Hub.
    HubDescription string
    A description of the hub.
    HubDisplayName string
    The display name of the hub.
    HubName string
    The name of the hub.
    HubSearchKeywords []string
    The searchable keywords for the hub.
    S3StorageConfig HubS3StorageConfigArgs
    The Amazon S3 storage configuration for the hub. See S3 Storage Config details below.
    Tags 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.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Hub.
    hubDescription String
    A description of the hub.
    hubDisplayName String
    The display name of the hub.
    hubName String
    The name of the hub.
    hubSearchKeywords List<String>
    The searchable keywords for the hub.
    s3StorageConfig HubS3StorageConfig
    The Amazon S3 storage configuration for the hub. See S3 Storage Config details below.
    tags 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.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Hub.
    hubDescription string
    A description of the hub.
    hubDisplayName string
    The display name of the hub.
    hubName string
    The name of the hub.
    hubSearchKeywords string[]
    The searchable keywords for the hub.
    s3StorageConfig HubS3StorageConfig
    The Amazon S3 storage configuration for the hub. See S3 Storage Config details below.
    tags {[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.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Amazon Resource Name (ARN) assigned by AWS to this Hub.
    hub_description str
    A description of the hub.
    hub_display_name str
    The display name of the hub.
    hub_name str
    The name of the hub.
    hub_search_keywords Sequence[str]
    The searchable keywords for the hub.
    s3_storage_config HubS3StorageConfigArgs
    The Amazon S3 storage configuration for the hub. See S3 Storage Config details below.
    tags 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.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Hub.
    hubDescription String
    A description of the hub.
    hubDisplayName String
    The display name of the hub.
    hubName String
    The name of the hub.
    hubSearchKeywords List<String>
    The searchable keywords for the hub.
    s3StorageConfig Property Map
    The Amazon S3 storage configuration for the hub. See S3 Storage Config details below.
    tags 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.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    HubS3StorageConfig, HubS3StorageConfigArgs

    S3OutputPath string
    The Amazon S3 bucket prefix for hosting hub content.interface.
    S3OutputPath string
    The Amazon S3 bucket prefix for hosting hub content.interface.
    s3OutputPath String
    The Amazon S3 bucket prefix for hosting hub content.interface.
    s3OutputPath string
    The Amazon S3 bucket prefix for hosting hub content.interface.
    s3_output_path str
    The Amazon S3 bucket prefix for hosting hub content.interface.
    s3OutputPath String
    The Amazon S3 bucket prefix for hosting hub content.interface.

    Import

    Using pulumi import, import SageMaker Hubs using the name. For example:

    $ pulumi import aws:sagemaker/hub:Hub test_hub my-code-repo

    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.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws