Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Hsdp Provider
  3. API Docs
  4. ContainerHost
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software
philips-software/terraform-provider-hsdp

hsdp.ContainerHost

Explore with Pulumi AI

hsdp logo
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software
philips-software/terraform-provider-hsdp

    Import

    Importing existing instances is supported but not recommended.

    Create ContainerHost Resource

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

    Constructor syntax

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

@overload
def ContainerHost(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  agent: Optional[bool] = None,
                  bastion_host: Optional[str] = None,
                  commands: Optional[Sequence[str]] = None,
                  commands_after_file_changes: Optional[bool] = None,
                  container_host_id: Optional[str] = None,
                  encrypt_volumes: Optional[bool] = None,
                  files: Optional[Sequence[ContainerHostFileArgs]] = None,
                  image: Optional[str] = None,
                  instance_role: Optional[str] = None,
                  instance_type: Optional[str] = None,
                  iops: Optional[float] = None,
                  keep_failed_instances: Optional[bool] = None,
                  name: Optional[str] = None,
                  private_key: Optional[str] = None,
                  protect: Optional[bool] = None,
                  security_groups: Optional[Sequence[str]] = None,
                  subnet: Optional[str] = None,
                  subnet_type: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None,
                  timeouts: Optional[ContainerHostTimeoutsArgs] = None,
                  user: Optional[str] = None,
                  user_groups: Optional[Sequence[str]] = None,
                  volume_size: Optional[float] = None,
                  volume_type: Optional[str] = None,
                  volumes: Optional[float] = None)
    func NewContainerHost(ctx *Context, name string, args *ContainerHostArgs, opts ...ResourceOption) (*ContainerHost, error)
    public ContainerHost(string name, ContainerHostArgs? args = null, CustomResourceOptions? opts = null)
    public ContainerHost(String name, ContainerHostArgs args)
public ContainerHost(String name, ContainerHostArgs args, CustomResourceOptions options)

    type: hsdp:ContainerHost
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 ContainerHostArgs
    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 ContainerHostArgs
    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 ContainerHostArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ContainerHostArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ContainerHostArgs
    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 containerHostResource = new Hsdp.ContainerHost("containerHostResource", new()
{
    Agent = false,
    BastionHost = "string",
    CommandsAfterFileChanges = false,
    ContainerHostId = "string",
    EncryptVolumes = false,
    Image = "string",
    InstanceRole = "string",
    InstanceType = "string",
    Iops = 0,
    KeepFailedInstances = false,
    Name = "string",
    PrivateKey = "string",
    Protect = false,
    SecurityGroups = new[]
    {
        "string",
    },
    Subnet = "string",
    SubnetType = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Timeouts = new Hsdp.Inputs.ContainerHostTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
    User = "string",
    UserGroups = new[]
    {
        "string",
    },
    VolumeSize = 0,
    VolumeType = "string",
    Volumes = 0,
});

    example, err := hsdp.NewContainerHost(ctx, "containerHostResource", &hsdp.ContainerHostArgs{
	Agent:                    pulumi.Bool(false),
	BastionHost:              pulumi.String("string"),
	CommandsAfterFileChanges: pulumi.Bool(false),
	ContainerHostId:          pulumi.String("string"),
	EncryptVolumes:           pulumi.Bool(false),
	Image:                    pulumi.String("string"),
	InstanceRole:             pulumi.String("string"),
	InstanceType:             pulumi.String("string"),
	Iops:                     pulumi.Float64(0),
	KeepFailedInstances:      pulumi.Bool(false),
	Name:                     pulumi.String("string"),
	PrivateKey:               pulumi.String("string"),
	Protect:                  pulumi.Bool(false),
	SecurityGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	Subnet:     pulumi.String("string"),
	SubnetType: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Timeouts: &hsdp.ContainerHostTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	User: pulumi.String("string"),
	UserGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	VolumeSize: pulumi.Float64(0),
	VolumeType: pulumi.String("string"),
	Volumes:    pulumi.Float64(0),
})

    var containerHostResource = new ContainerHost("containerHostResource", ContainerHostArgs.builder()
    .agent(false)
    .bastionHost("string")
    .commandsAfterFileChanges(false)
    .containerHostId("string")
    .encryptVolumes(false)
    .image("string")
    .instanceRole("string")
    .instanceType("string")
    .iops(0)
    .keepFailedInstances(false)
    .name("string")
    .privateKey("string")
    .protect(false)
    .securityGroups("string")
    .subnet("string")
    .subnetType("string")
    .tags(Map.of("string", "string"))
    .timeouts(ContainerHostTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .user("string")
    .userGroups("string")
    .volumeSize(0)
    .volumeType("string")
    .volumes(0)
    .build());

    container_host_resource = hsdp.ContainerHost("containerHostResource",
    agent=False,
    bastion_host="string",
    commands_after_file_changes=False,
    container_host_id="string",
    encrypt_volumes=False,
    image="string",
    instance_role="string",
    instance_type="string",
    iops=0,
    keep_failed_instances=False,
    name="string",
    private_key="string",
    protect=False,
    security_groups=["string"],
    subnet="string",
    subnet_type="string",
    tags={
        "string": "string",
    },
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    },
    user="string",
    user_groups=["string"],
    volume_size=0,
    volume_type="string",
    volumes=0)

    const containerHostResource = new hsdp.ContainerHost("containerHostResource", {
    agent: false,
    bastionHost: "string",
    commandsAfterFileChanges: false,
    containerHostId: "string",
    encryptVolumes: false,
    image: "string",
    instanceRole: "string",
    instanceType: "string",
    iops: 0,
    keepFailedInstances: false,
    name: "string",
    privateKey: "string",
    protect: false,
    securityGroups: ["string"],
    subnet: "string",
    subnetType: "string",
    tags: {
        string: "string",
    },
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
    user: "string",
    userGroups: ["string"],
    volumeSize: 0,
    volumeType: "string",
    volumes: 0,
});

    type: hsdp:ContainerHost
properties:
    agent: false
    bastionHost: string
    commandsAfterFileChanges: false
    containerHostId: string
    encryptVolumes: false
    image: string
    instanceRole: string
    instanceType: string
    iops: 0
    keepFailedInstances: false
    name: string
    privateKey: string
    protect: false
    securityGroups:
        - string
    subnet: string
    subnetType: string
    tags:
        string: string
    timeouts:
        create: string
        delete: string
        update: string
    user: string
    userGroups:
        - string
    volumeSize: 0
    volumeType: string
    volumes: 0

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

    Agent bool
    Signals the resource should use an SSH-agent connection. Default is false
    BastionHost string
    The bastion host to use. When not set, this will be deduced from the container host location
    Commands List<string>

    Deprecated: Deprecated

    CommandsAfterFileChanges bool
    ContainerHostId string
    The instance ID
    EncryptVolumes bool
    When set encrypts volumes. Default is true
    Files List<ContainerHostFile>
    Block specifying content to be written to the container host after creation

    Deprecated: Deprecated

    Image string
    The OS image to use. Only use this if you have access to additional image types (example: centos7). Conflicts with instance_role value container-host
    InstanceRole string
    The role to use. Default container-host (other values: vanilla, base)
    InstanceType string
    The EC2 instance type to use. Default m5.large
    Iops double
    Number of guaranteed IOPs to provision. Supported value range 1-4000
    KeepFailedInstances bool
    Keep instances around for post-mortem analysis on failure. Default is false.
    Name string
    The container host name. Must be unique.
    PrivateKey string
    The SSH private key to use for provision activities
    Protect bool
    Boolean when set will enable protection for container host.
    SecurityGroups List<string>
    list(string) of Security groups to attach. Default [], Maximum 4
    Subnet string
    This will cause a new instance to get deployed on a specific subnet. Conflicts with subnet_type. You should only use this option if you have very specific requirements that dictate all the instances you are creating need to reside in the same AZ. An example of this would be a cluster of systems that need to reside in the same datacenter.
    SubnetType string
    What subnet type to use. Can be public or private. Default is private.
    Tags Dictionary<string, string>
    Map of tags to assign to the instances
    Timeouts ContainerHostTimeouts
    User string
    The username to use for provision activities using SSH
    UserGroups List<string>
    list(string) of User groups to attach. Default [], Maximum 50
    VolumeSize double
    Volume size in GB. Supported value range 1-16000 (16 TB max)
    VolumeType string
    The EBS volume type. Default is gp2. You can also choose io1 which is default when you specify iops value
    Volumes double
    Number of additional volumes to attach. Default 0, Maximum 6
    Agent bool
    Signals the resource should use an SSH-agent connection. Default is false
    BastionHost string
    The bastion host to use. When not set, this will be deduced from the container host location
    Commands []string

    Deprecated: Deprecated

    CommandsAfterFileChanges bool
    ContainerHostId string
    The instance ID
    EncryptVolumes bool
    When set encrypts volumes. Default is true
    Files []ContainerHostFileArgs
    Block specifying content to be written to the container host after creation

    Deprecated: Deprecated

    Image string
    The OS image to use. Only use this if you have access to additional image types (example: centos7). Conflicts with instance_role value container-host
    InstanceRole string
    The role to use. Default container-host (other values: vanilla, base)
    InstanceType string
    The EC2 instance type to use. Default m5.large
    Iops float64
    Number of guaranteed IOPs to provision. Supported value range 1-4000
    KeepFailedInstances bool
    Keep instances around for post-mortem analysis on failure. Default is false.
    Name string
    The container host name. Must be unique.
    PrivateKey string
    The SSH private key to use for provision activities
    Protect bool
    Boolean when set will enable protection for container host.
    SecurityGroups []string
    list(string) of Security groups to attach. Default [], Maximum 4
    Subnet string
    This will cause a new instance to get deployed on a specific subnet. Conflicts with subnet_type. You should only use this option if you have very specific requirements that dictate all the instances you are creating need to reside in the same AZ. An example of this would be a cluster of systems that need to reside in the same datacenter.
    SubnetType string
    What subnet type to use. Can be public or private. Default is private.
    Tags map[string]string
    Map of tags to assign to the instances
    Timeouts ContainerHostTimeoutsArgs
    User string
    The username to use for provision activities using SSH
    UserGroups []string
    list(string) of User groups to attach. Default [], Maximum 50
    VolumeSize float64
    Volume size in GB. Supported value range 1-16000 (16 TB max)
    VolumeType string
    The EBS volume type. Default is gp2. You can also choose io1 which is default when you specify iops value
    Volumes float64
    Number of additional volumes to attach. Default 0, Maximum 6
    agent Boolean
    Signals the resource should use an SSH-agent connection. Default is false
    bastionHost String
    The bastion host to use. When not set, this will be deduced from the container host location
    commands List<String>

    Deprecated: Deprecated

    commandsAfterFileChanges Boolean
    containerHostId String
    The instance ID
    encryptVolumes Boolean
    When set encrypts volumes. Default is true
    files List<ContainerHostFile>
    Block specifying content to be written to the container host after creation

    Deprecated: Deprecated

    image String
    The OS image to use. Only use this if you have access to additional image types (example: centos7). Conflicts with instance_role value container-host
    instanceRole String
    The role to use. Default container-host (other values: vanilla, base)
    instanceType String
    The EC2 instance type to use. Default m5.large
    iops Double
    Number of guaranteed IOPs to provision. Supported value range 1-4000
    keepFailedInstances Boolean
    Keep instances around for post-mortem analysis on failure. Default is false.
    name String
    The container host name. Must be unique.
    privateKey String
    The SSH private key to use for provision activities
    protect Boolean
    Boolean when set will enable protection for container host.
    securityGroups List<String>
    list(string) of Security groups to attach. Default [], Maximum 4
    subnet String
    This will cause a new instance to get deployed on a specific subnet. Conflicts with subnet_type. You should only use this option if you have very specific requirements that dictate all the instances you are creating need to reside in the same AZ. An example of this would be a cluster of systems that need to reside in the same datacenter.
    subnetType String
    What subnet type to use. Can be public or private. Default is private.
    tags Map<String,String>
    Map of tags to assign to the instances
    timeouts ContainerHostTimeouts
    user String
    The username to use for provision activities using SSH
    userGroups List<String>
    list(string) of User groups to attach. Default [], Maximum 50
    volumeSize Double
    Volume size in GB. Supported value range 1-16000 (16 TB max)
    volumeType String
    The EBS volume type. Default is gp2. You can also choose io1 which is default when you specify iops value
    volumes Double
    Number of additional volumes to attach. Default 0, Maximum 6
    agent boolean
    Signals the resource should use an SSH-agent connection. Default is false
    bastionHost string
    The bastion host to use. When not set, this will be deduced from the container host location
    commands string[]

    Deprecated: Deprecated

    commandsAfterFileChanges boolean
    containerHostId string
    The instance ID
    encryptVolumes boolean
    When set encrypts volumes. Default is true
    files ContainerHostFile[]
    Block specifying content to be written to the container host after creation

    Deprecated: Deprecated

    image string
    The OS image to use. Only use this if you have access to additional image types (example: centos7). Conflicts with instance_role value container-host
    instanceRole string
    The role to use. Default container-host (other values: vanilla, base)
    instanceType string
    The EC2 instance type to use. Default m5.large
    iops number
    Number of guaranteed IOPs to provision. Supported value range 1-4000
    keepFailedInstances boolean
    Keep instances around for post-mortem analysis on failure. Default is false.
    name string
    The container host name. Must be unique.
    privateKey string
    The SSH private key to use for provision activities
    protect boolean
    Boolean when set will enable protection for container host.
    securityGroups string[]
    list(string) of Security groups to attach. Default [], Maximum 4
    subnet string
    This will cause a new instance to get deployed on a specific subnet. Conflicts with subnet_type. You should only use this option if you have very specific requirements that dictate all the instances you are creating need to reside in the same AZ. An example of this would be a cluster of systems that need to reside in the same datacenter.
    subnetType string
    What subnet type to use. Can be public or private. Default is private.
    tags {[key: string]: string}
    Map of tags to assign to the instances
    timeouts ContainerHostTimeouts
    user string
    The username to use for provision activities using SSH
    userGroups string[]
    list(string) of User groups to attach. Default [], Maximum 50
    volumeSize number
    Volume size in GB. Supported value range 1-16000 (16 TB max)
    volumeType string
    The EBS volume type. Default is gp2. You can also choose io1 which is default when you specify iops value
    volumes number
    Number of additional volumes to attach. Default 0, Maximum 6
    agent bool
    Signals the resource should use an SSH-agent connection. Default is false
    bastion_host str
    The bastion host to use. When not set, this will be deduced from the container host location
    commands Sequence[str]

    Deprecated: Deprecated

    commands_after_file_changes bool
    container_host_id str
    The instance ID
    encrypt_volumes bool
    When set encrypts volumes. Default is true
    files Sequence[ContainerHostFileArgs]
    Block specifying content to be written to the container host after creation

    Deprecated: Deprecated

    image str
    The OS image to use. Only use this if you have access to additional image types (example: centos7). Conflicts with instance_role value container-host
    instance_role str
    The role to use. Default container-host (other values: vanilla, base)
    instance_type str
    The EC2 instance type to use. Default m5.large
    iops float
    Number of guaranteed IOPs to provision. Supported value range 1-4000
    keep_failed_instances bool
    Keep instances around for post-mortem analysis on failure. Default is false.
    name str
    The container host name. Must be unique.
    private_key str
    The SSH private key to use for provision activities
    protect bool
    Boolean when set will enable protection for container host.
    security_groups Sequence[str]
    list(string) of Security groups to attach. Default [], Maximum 4
    subnet str
    This will cause a new instance to get deployed on a specific subnet. Conflicts with subnet_type. You should only use this option if you have very specific requirements that dictate all the instances you are creating need to reside in the same AZ. An example of this would be a cluster of systems that need to reside in the same datacenter.
    subnet_type str
    What subnet type to use. Can be public or private. Default is private.
    tags Mapping[str, str]
    Map of tags to assign to the instances
    timeouts ContainerHostTimeoutsArgs
    user str
    The username to use for provision activities using SSH
    user_groups Sequence[str]
    list(string) of User groups to attach. Default [], Maximum 50
    volume_size float
    Volume size in GB. Supported value range 1-16000 (16 TB max)
    volume_type str
    The EBS volume type. Default is gp2. You can also choose io1 which is default when you specify iops value
    volumes float
    Number of additional volumes to attach. Default 0, Maximum 6
    agent Boolean
    Signals the resource should use an SSH-agent connection. Default is false
    bastionHost String
    The bastion host to use. When not set, this will be deduced from the container host location
    commands List<String>

    Deprecated: Deprecated

    commandsAfterFileChanges Boolean
    containerHostId String
    The instance ID
    encryptVolumes Boolean
    When set encrypts volumes. Default is true
    files List<Property Map>
    Block specifying content to be written to the container host after creation

    Deprecated: Deprecated

    image String
    The OS image to use. Only use this if you have access to additional image types (example: centos7). Conflicts with instance_role value container-host
    instanceRole String
    The role to use. Default container-host (other values: vanilla, base)
    instanceType String
    The EC2 instance type to use. Default m5.large
    iops Number
    Number of guaranteed IOPs to provision. Supported value range 1-4000
    keepFailedInstances Boolean
    Keep instances around for post-mortem analysis on failure. Default is false.
    name String
    The container host name. Must be unique.
    privateKey String
    The SSH private key to use for provision activities
    protect Boolean
    Boolean when set will enable protection for container host.
    securityGroups List<String>
    list(string) of Security groups to attach. Default [], Maximum 4
    subnet String
    This will cause a new instance to get deployed on a specific subnet. Conflicts with subnet_type. You should only use this option if you have very specific requirements that dictate all the instances you are creating need to reside in the same AZ. An example of this would be a cluster of systems that need to reside in the same datacenter.
    subnetType String
    What subnet type to use. Can be public or private. Default is private.
    tags Map<String>
    Map of tags to assign to the instances
    timeouts Property Map
    user String
    The username to use for provision activities using SSH
    userGroups List<String>
    list(string) of User groups to attach. Default [], Maximum 50
    volumeSize Number
    Volume size in GB. Supported value range 1-16000 (16 TB max)
    volumeType String
    The EBS volume type. Default is gp2. You can also choose io1 which is default when you specify iops value
    volumes Number
    Number of additional volumes to attach. Default 0, Maximum 6

    Outputs

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

    BlockDevices List<string>
    The list of block devices attached to the instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    LaunchTime string
    Timestamp when the instance was launched.
    PrivateIp string
    The private IP address of the instance
    PublicIp string
    The public IP address of the instance if it has one
    Result string
    The stdout of the last command executed in the commands list
    Role string
    The role of the instance.
    Vpc string
    The VPC the instance was provisioned in.
    Zone string
    The Zone the instance was provisioned in.
    BlockDevices []string
    The list of block devices attached to the instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    LaunchTime string
    Timestamp when the instance was launched.
    PrivateIp string
    The private IP address of the instance
    PublicIp string
    The public IP address of the instance if it has one
    Result string
    The stdout of the last command executed in the commands list
    Role string
    The role of the instance.
    Vpc string
    The VPC the instance was provisioned in.
    Zone string
    The Zone the instance was provisioned in.
    blockDevices List<String>
    The list of block devices attached to the instance.
    id String
    The provider-assigned unique ID for this managed resource.
    launchTime String
    Timestamp when the instance was launched.
    privateIp String
    The private IP address of the instance
    publicIp String
    The public IP address of the instance if it has one
    result String
    The stdout of the last command executed in the commands list
    role String
    The role of the instance.
    vpc String
    The VPC the instance was provisioned in.
    zone String
    The Zone the instance was provisioned in.
    blockDevices string[]
    The list of block devices attached to the instance.
    id string
    The provider-assigned unique ID for this managed resource.
    launchTime string
    Timestamp when the instance was launched.
    privateIp string
    The private IP address of the instance
    publicIp string
    The public IP address of the instance if it has one
    result string
    The stdout of the last command executed in the commands list
    role string
    The role of the instance.
    vpc string
    The VPC the instance was provisioned in.
    zone string
    The Zone the instance was provisioned in.
    block_devices Sequence[str]
    The list of block devices attached to the instance.
    id str
    The provider-assigned unique ID for this managed resource.
    launch_time str
    Timestamp when the instance was launched.
    private_ip str
    The private IP address of the instance
    public_ip str
    The public IP address of the instance if it has one
    result str
    The stdout of the last command executed in the commands list
    role str
    The role of the instance.
    vpc str
    The VPC the instance was provisioned in.
    zone str
    The Zone the instance was provisioned in.
    blockDevices List<String>
    The list of block devices attached to the instance.
    id String
    The provider-assigned unique ID for this managed resource.
    launchTime String
    Timestamp when the instance was launched.
    privateIp String
    The private IP address of the instance
    publicIp String
    The public IP address of the instance if it has one
    result String
    The stdout of the last command executed in the commands list
    role String
    The role of the instance.
    vpc String
    The VPC the instance was provisioned in.
    zone String
    The Zone the instance was provisioned in.

    Look up Existing ContainerHost Resource

    Get an existing ContainerHost 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?: ContainerHostState, opts?: CustomResourceOptions): ContainerHost
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        agent: Optional[bool] = None,
        bastion_host: Optional[str] = None,
        block_devices: Optional[Sequence[str]] = None,
        commands: Optional[Sequence[str]] = None,
        commands_after_file_changes: Optional[bool] = None,
        container_host_id: Optional[str] = None,
        encrypt_volumes: Optional[bool] = None,
        files: Optional[Sequence[ContainerHostFileArgs]] = None,
        image: Optional[str] = None,
        instance_role: Optional[str] = None,
        instance_type: Optional[str] = None,
        iops: Optional[float] = None,
        keep_failed_instances: Optional[bool] = None,
        launch_time: Optional[str] = None,
        name: Optional[str] = None,
        private_ip: Optional[str] = None,
        private_key: Optional[str] = None,
        protect: Optional[bool] = None,
        public_ip: Optional[str] = None,
        result: Optional[str] = None,
        role: Optional[str] = None,
        security_groups: Optional[Sequence[str]] = None,
        subnet: Optional[str] = None,
        subnet_type: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        timeouts: Optional[ContainerHostTimeoutsArgs] = None,
        user: Optional[str] = None,
        user_groups: Optional[Sequence[str]] = None,
        volume_size: Optional[float] = None,
        volume_type: Optional[str] = None,
        volumes: Optional[float] = None,
        vpc: Optional[str] = None,
        zone: Optional[str] = None) -> ContainerHost
    func GetContainerHost(ctx *Context, name string, id IDInput, state *ContainerHostState, opts ...ResourceOption) (*ContainerHost, error)
    public static ContainerHost Get(string name, Input<string> id, ContainerHostState? state, CustomResourceOptions? opts = null)
    public static ContainerHost get(String name, Output<String> id, ContainerHostState state, CustomResourceOptions options)
    resources:  _:    type: hsdp:ContainerHost    get:      id: ${id}
    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:
    Agent bool
    Signals the resource should use an SSH-agent connection. Default is false
    BastionHost string
    The bastion host to use. When not set, this will be deduced from the container host location
    BlockDevices List<string>
    The list of block devices attached to the instance.
    Commands List<string>

    Deprecated: Deprecated

    CommandsAfterFileChanges bool
    ContainerHostId string
    The instance ID
    EncryptVolumes bool
    When set encrypts volumes. Default is true
    Files List<ContainerHostFile>
    Block specifying content to be written to the container host after creation

    Deprecated: Deprecated

    Image string
    The OS image to use. Only use this if you have access to additional image types (example: centos7). Conflicts with instance_role value container-host
    InstanceRole string
    The role to use. Default container-host (other values: vanilla, base)
    InstanceType string
    The EC2 instance type to use. Default m5.large
    Iops double
    Number of guaranteed IOPs to provision. Supported value range 1-4000
    KeepFailedInstances bool
    Keep instances around for post-mortem analysis on failure. Default is false.
    LaunchTime string
    Timestamp when the instance was launched.
    Name string
    The container host name. Must be unique.
    PrivateIp string
    The private IP address of the instance
    PrivateKey string
    The SSH private key to use for provision activities
    Protect bool
    Boolean when set will enable protection for container host.
    PublicIp string
    The public IP address of the instance if it has one
    Result string
    The stdout of the last command executed in the commands list
    Role string
    The role of the instance.
    SecurityGroups List<string>
    list(string) of Security groups to attach. Default [], Maximum 4
    Subnet string
    This will cause a new instance to get deployed on a specific subnet. Conflicts with subnet_type. You should only use this option if you have very specific requirements that dictate all the instances you are creating need to reside in the same AZ. An example of this would be a cluster of systems that need to reside in the same datacenter.
    SubnetType string
    What subnet type to use. Can be public or private. Default is private.
    Tags Dictionary<string, string>
    Map of tags to assign to the instances
    Timeouts ContainerHostTimeouts
    User string
    The username to use for provision activities using SSH
    UserGroups List<string>
    list(string) of User groups to attach. Default [], Maximum 50
    VolumeSize double
    Volume size in GB. Supported value range 1-16000 (16 TB max)
    VolumeType string
    The EBS volume type. Default is gp2. You can also choose io1 which is default when you specify iops value
    Volumes double
    Number of additional volumes to attach. Default 0, Maximum 6
    Vpc string
    The VPC the instance was provisioned in.
    Zone string
    The Zone the instance was provisioned in.
    Agent bool
    Signals the resource should use an SSH-agent connection. Default is false
    BastionHost string
    The bastion host to use. When not set, this will be deduced from the container host location
    BlockDevices []string
    The list of block devices attached to the instance.
    Commands []string

    Deprecated: Deprecated

    CommandsAfterFileChanges bool
    ContainerHostId string
    The instance ID
    EncryptVolumes bool
    When set encrypts volumes. Default is true
    Files []ContainerHostFileArgs
    Block specifying content to be written to the container host after creation

    Deprecated: Deprecated

    Image string
    The OS image to use. Only use this if you have access to additional image types (example: centos7). Conflicts with instance_role value container-host
    InstanceRole string
    The role to use. Default container-host (other values: vanilla, base)
    InstanceType string
    The EC2 instance type to use. Default m5.large
    Iops float64
    Number of guaranteed IOPs to provision. Supported value range 1-4000
    KeepFailedInstances bool
    Keep instances around for post-mortem analysis on failure. Default is false.
    LaunchTime string
    Timestamp when the instance was launched.
    Name string
    The container host name. Must be unique.
    PrivateIp string
    The private IP address of the instance
    PrivateKey string
    The SSH private key to use for provision activities
    Protect bool
    Boolean when set will enable protection for container host.
    PublicIp string
    The public IP address of the instance if it has one
    Result string
    The stdout of the last command executed in the commands list
    Role string
    The role of the instance.
    SecurityGroups []string
    list(string) of Security groups to attach. Default [], Maximum 4
    Subnet string
    This will cause a new instance to get deployed on a specific subnet. Conflicts with subnet_type. You should only use this option if you have very specific requirements that dictate all the instances you are creating need to reside in the same AZ. An example of this would be a cluster of systems that need to reside in the same datacenter.
    SubnetType string
    What subnet type to use. Can be public or private. Default is private.
    Tags map[string]string
    Map of tags to assign to the instances
    Timeouts ContainerHostTimeoutsArgs
    User string
    The username to use for provision activities using SSH
    UserGroups []string
    list(string) of User groups to attach. Default [], Maximum 50
    VolumeSize float64
    Volume size in GB. Supported value range 1-16000 (16 TB max)
    VolumeType string
    The EBS volume type. Default is gp2. You can also choose io1 which is default when you specify iops value
    Volumes float64
    Number of additional volumes to attach. Default 0, Maximum 6
    Vpc string
    The VPC the instance was provisioned in.
    Zone string
    The Zone the instance was provisioned in.
    agent Boolean
    Signals the resource should use an SSH-agent connection. Default is false
    bastionHost String
    The bastion host to use. When not set, this will be deduced from the container host location
    blockDevices List<String>
    The list of block devices attached to the instance.
    commands List<String>

    Deprecated: Deprecated

    commandsAfterFileChanges Boolean
    containerHostId String
    The instance ID
    encryptVolumes Boolean
    When set encrypts volumes. Default is true
    files List<ContainerHostFile>
    Block specifying content to be written to the container host after creation

    Deprecated: Deprecated

    image String
    The OS image to use. Only use this if you have access to additional image types (example: centos7). Conflicts with instance_role value container-host
    instanceRole String
    The role to use. Default container-host (other values: vanilla, base)
    instanceType String
    The EC2 instance type to use. Default m5.large
    iops Double
    Number of guaranteed IOPs to provision. Supported value range 1-4000
    keepFailedInstances Boolean
    Keep instances around for post-mortem analysis on failure. Default is false.
    launchTime String
    Timestamp when the instance was launched.
    name String
    The container host name. Must be unique.
    privateIp String
    The private IP address of the instance
    privateKey String
    The SSH private key to use for provision activities
    protect Boolean
    Boolean when set will enable protection for container host.
    publicIp String
    The public IP address of the instance if it has one
    result String
    The stdout of the last command executed in the commands list
    role String
    The role of the instance.
    securityGroups List<String>
    list(string) of Security groups to attach. Default [], Maximum 4
    subnet String
    This will cause a new instance to get deployed on a specific subnet. Conflicts with subnet_type. You should only use this option if you have very specific requirements that dictate all the instances you are creating need to reside in the same AZ. An example of this would be a cluster of systems that need to reside in the same datacenter.
    subnetType String
    What subnet type to use. Can be public or private. Default is private.
    tags Map<String,String>
    Map of tags to assign to the instances
    timeouts ContainerHostTimeouts
    user String
    The username to use for provision activities using SSH
    userGroups List<String>
    list(string) of User groups to attach. Default [], Maximum 50
    volumeSize Double
    Volume size in GB. Supported value range 1-16000 (16 TB max)
    volumeType String
    The EBS volume type. Default is gp2. You can also choose io1 which is default when you specify iops value
    volumes Double
    Number of additional volumes to attach. Default 0, Maximum 6
    vpc String
    The VPC the instance was provisioned in.
    zone String
    The Zone the instance was provisioned in.
    agent boolean
    Signals the resource should use an SSH-agent connection. Default is false
    bastionHost string
    The bastion host to use. When not set, this will be deduced from the container host location
    blockDevices string[]
    The list of block devices attached to the instance.
    commands string[]

    Deprecated: Deprecated

    commandsAfterFileChanges boolean
    containerHostId string
    The instance ID
    encryptVolumes boolean
    When set encrypts volumes. Default is true
    files ContainerHostFile[]
    Block specifying content to be written to the container host after creation

    Deprecated: Deprecated

    image string
    The OS image to use. Only use this if you have access to additional image types (example: centos7). Conflicts with instance_role value container-host
    instanceRole string
    The role to use. Default container-host (other values: vanilla, base)
    instanceType string
    The EC2 instance type to use. Default m5.large
    iops number
    Number of guaranteed IOPs to provision. Supported value range 1-4000
    keepFailedInstances boolean
    Keep instances around for post-mortem analysis on failure. Default is false.
    launchTime string
    Timestamp when the instance was launched.
    name string
    The container host name. Must be unique.
    privateIp string
    The private IP address of the instance
    privateKey string
    The SSH private key to use for provision activities
    protect boolean
    Boolean when set will enable protection for container host.
    publicIp string
    The public IP address of the instance if it has one
    result string
    The stdout of the last command executed in the commands list
    role string
    The role of the instance.
    securityGroups string[]
    list(string) of Security groups to attach. Default [], Maximum 4
    subnet string
    This will cause a new instance to get deployed on a specific subnet. Conflicts with subnet_type. You should only use this option if you have very specific requirements that dictate all the instances you are creating need to reside in the same AZ. An example of this would be a cluster of systems that need to reside in the same datacenter.
    subnetType string
    What subnet type to use. Can be public or private. Default is private.
    tags {[key: string]: string}
    Map of tags to assign to the instances
    timeouts ContainerHostTimeouts
    user string
    The username to use for provision activities using SSH
    userGroups string[]
    list(string) of User groups to attach. Default [], Maximum 50
    volumeSize number
    Volume size in GB. Supported value range 1-16000 (16 TB max)
    volumeType string
    The EBS volume type. Default is gp2. You can also choose io1 which is default when you specify iops value
    volumes number
    Number of additional volumes to attach. Default 0, Maximum 6
    vpc string
    The VPC the instance was provisioned in.
    zone string
    The Zone the instance was provisioned in.
    agent bool
    Signals the resource should use an SSH-agent connection. Default is false
    bastion_host str
    The bastion host to use. When not set, this will be deduced from the container host location
    block_devices Sequence[str]
    The list of block devices attached to the instance.
    commands Sequence[str]

    Deprecated: Deprecated

    commands_after_file_changes bool
    container_host_id str
    The instance ID
    encrypt_volumes bool
    When set encrypts volumes. Default is true
    files Sequence[ContainerHostFileArgs]
    Block specifying content to be written to the container host after creation

    Deprecated: Deprecated

    image str
    The OS image to use. Only use this if you have access to additional image types (example: centos7). Conflicts with instance_role value container-host
    instance_role str
    The role to use. Default container-host (other values: vanilla, base)
    instance_type str
    The EC2 instance type to use. Default m5.large
    iops float
    Number of guaranteed IOPs to provision. Supported value range 1-4000
    keep_failed_instances bool
    Keep instances around for post-mortem analysis on failure. Default is false.
    launch_time str
    Timestamp when the instance was launched.
    name str
    The container host name. Must be unique.
    private_ip str
    The private IP address of the instance
    private_key str
    The SSH private key to use for provision activities
    protect bool
    Boolean when set will enable protection for container host.
    public_ip str
    The public IP address of the instance if it has one
    result str
    The stdout of the last command executed in the commands list
    role str
    The role of the instance.
    security_groups Sequence[str]
    list(string) of Security groups to attach. Default [], Maximum 4
    subnet str
    This will cause a new instance to get deployed on a specific subnet. Conflicts with subnet_type. You should only use this option if you have very specific requirements that dictate all the instances you are creating need to reside in the same AZ. An example of this would be a cluster of systems that need to reside in the same datacenter.
    subnet_type str
    What subnet type to use. Can be public or private. Default is private.
    tags Mapping[str, str]
    Map of tags to assign to the instances
    timeouts ContainerHostTimeoutsArgs
    user str
    The username to use for provision activities using SSH
    user_groups Sequence[str]
    list(string) of User groups to attach. Default [], Maximum 50
    volume_size float
    Volume size in GB. Supported value range 1-16000 (16 TB max)
    volume_type str
    The EBS volume type. Default is gp2. You can also choose io1 which is default when you specify iops value
    volumes float
    Number of additional volumes to attach. Default 0, Maximum 6
    vpc str
    The VPC the instance was provisioned in.
    zone str
    The Zone the instance was provisioned in.
    agent Boolean
    Signals the resource should use an SSH-agent connection. Default is false
    bastionHost String
    The bastion host to use. When not set, this will be deduced from the container host location
    blockDevices List<String>
    The list of block devices attached to the instance.
    commands List<String>

    Deprecated: Deprecated

    commandsAfterFileChanges Boolean
    containerHostId String
    The instance ID
    encryptVolumes Boolean
    When set encrypts volumes. Default is true
    files List<Property Map>
    Block specifying content to be written to the container host after creation

    Deprecated: Deprecated

    image String
    The OS image to use. Only use this if you have access to additional image types (example: centos7). Conflicts with instance_role value container-host
    instanceRole String
    The role to use. Default container-host (other values: vanilla, base)
    instanceType String
    The EC2 instance type to use. Default m5.large
    iops Number
    Number of guaranteed IOPs to provision. Supported value range 1-4000
    keepFailedInstances Boolean
    Keep instances around for post-mortem analysis on failure. Default is false.
    launchTime String
    Timestamp when the instance was launched.
    name String
    The container host name. Must be unique.
    privateIp String
    The private IP address of the instance
    privateKey String
    The SSH private key to use for provision activities
    protect Boolean
    Boolean when set will enable protection for container host.
    publicIp String
    The public IP address of the instance if it has one
    result String
    The stdout of the last command executed in the commands list
    role String
    The role of the instance.
    securityGroups List<String>
    list(string) of Security groups to attach. Default [], Maximum 4
    subnet String
    This will cause a new instance to get deployed on a specific subnet. Conflicts with subnet_type. You should only use this option if you have very specific requirements that dictate all the instances you are creating need to reside in the same AZ. An example of this would be a cluster of systems that need to reside in the same datacenter.
    subnetType String
    What subnet type to use. Can be public or private. Default is private.
    tags Map<String>
    Map of tags to assign to the instances
    timeouts Property Map
    user String
    The username to use for provision activities using SSH
    userGroups List<String>
    list(string) of User groups to attach. Default [], Maximum 50
    volumeSize Number
    Volume size in GB. Supported value range 1-16000 (16 TB max)
    volumeType String
    The EBS volume type. Default is gp2. You can also choose io1 which is default when you specify iops value
    volumes Number
    Number of additional volumes to attach. Default 0, Maximum 6
    vpc String
    The VPC the instance was provisioned in.
    zone String
    The Zone the instance was provisioned in.

    Supporting Types

    ContainerHostFile, ContainerHostFileArgs

    Destination string
    Remote filename to store the content in
    Content string
    Content of the file. Conflicts with source
    Group string
    The file group. Default group is the SSH user's group
    Owner string
    The file owner. Default owner the SSH user
    Permissions string
    The file permissions. Default permissions are "0644"
    Source string
    Content of the file. Conflicts with content
    Destination string
    Remote filename to store the content in
    Content string
    Content of the file. Conflicts with source
    Group string
    The file group. Default group is the SSH user's group
    Owner string
    The file owner. Default owner the SSH user
    Permissions string
    The file permissions. Default permissions are "0644"
    Source string
    Content of the file. Conflicts with content
    destination String
    Remote filename to store the content in
    content String
    Content of the file. Conflicts with source
    group String
    The file group. Default group is the SSH user's group
    owner String
    The file owner. Default owner the SSH user
    permissions String
    The file permissions. Default permissions are "0644"
    source String
    Content of the file. Conflicts with content
    destination string
    Remote filename to store the content in
    content string
    Content of the file. Conflicts with source
    group string
    The file group. Default group is the SSH user's group
    owner string
    The file owner. Default owner the SSH user
    permissions string
    The file permissions. Default permissions are "0644"
    source string
    Content of the file. Conflicts with content
    destination str
    Remote filename to store the content in
    content str
    Content of the file. Conflicts with source
    group str
    The file group. Default group is the SSH user's group
    owner str
    The file owner. Default owner the SSH user
    permissions str
    The file permissions. Default permissions are "0644"
    source str
    Content of the file. Conflicts with content
    destination String
    Remote filename to store the content in
    content String
    Content of the file. Conflicts with source
    group String
    The file group. Default group is the SSH user's group
    owner String
    The file owner. Default owner the SSH user
    permissions String
    The file permissions. Default permissions are "0644"
    source String
    Content of the file. Conflicts with content

    ContainerHostTimeouts, ContainerHostTimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    Package Details

    Repository
    hsdp philips-software/terraform-provider-hsdp
    License
    Notes
    This Pulumi package is based on the hsdp Terraform Provider.
    hsdp logo
    hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software
    philips-software/terraform-provider-hsdp