Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. ContainerIngressInstance
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.ContainerIngressInstance

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

Registers an IBM Cloud Secrets Manager instance with your IBM Cloud Kubernetes Service or Red Hat OpenShift on IBM Cloud cluster. For more information about how this instance can be used see about Secrets Manager

Example Usage

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

const instance = new ibm.ContainerIngressInstance("instance", {
    cluster: "exampleClusterName",
    instanceCrn: _var.sm_instance_crn,
    isDefault: true,
});
Copy
import pulumi
import pulumi_ibm as ibm

instance = ibm.ContainerIngressInstance("instance",
    cluster="exampleClusterName",
    instance_crn=var["sm_instance_crn"],
    is_default=True)
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewContainerIngressInstance(ctx, "instance", &ibm.ContainerIngressInstanceArgs{
			Cluster:     pulumi.String("exampleClusterName"),
			InstanceCrn: pulumi.Any(_var.Sm_instance_crn),
			IsDefault:   pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var instance = new Ibm.ContainerIngressInstance("instance", new()
    {
        Cluster = "exampleClusterName",
        InstanceCrn = @var.Sm_instance_crn,
        IsDefault = true,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.ContainerIngressInstance;
import com.pulumi.ibm.ContainerIngressInstanceArgs;
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 instance = new ContainerIngressInstance("instance", ContainerIngressInstanceArgs.builder()
            .cluster("exampleClusterName")
            .instanceCrn(var_.sm_instance_crn())
            .isDefault(true)
            .build());

    }
}
Copy
resources:
  instance:
    type: ibm:ContainerIngressInstance
    properties:
      cluster: exampleClusterName
      instanceCrn: ${var.sm_instance_crn}
      isDefault: true
Copy

Create ContainerIngressInstance Resource

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

Constructor syntax

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

@overload
def ContainerIngressInstance(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             cluster: Optional[str] = None,
                             instance_crn: Optional[str] = None,
                             container_ingress_instance_id: Optional[str] = None,
                             is_default: Optional[bool] = None,
                             secret_group_id: Optional[str] = None,
                             timeouts: Optional[ContainerIngressInstanceTimeoutsArgs] = None)
func NewContainerIngressInstance(ctx *Context, name string, args ContainerIngressInstanceArgs, opts ...ResourceOption) (*ContainerIngressInstance, error)
public ContainerIngressInstance(string name, ContainerIngressInstanceArgs args, CustomResourceOptions? opts = null)
public ContainerIngressInstance(String name, ContainerIngressInstanceArgs args)
public ContainerIngressInstance(String name, ContainerIngressInstanceArgs args, CustomResourceOptions options)

type: ibm:ContainerIngressInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ContainerIngressInstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ContainerIngressInstanceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ContainerIngressInstanceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ContainerIngressInstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ContainerIngressInstanceArgs
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 containerIngressInstanceResource = new Ibm.ContainerIngressInstance("containerIngressInstanceResource", new()
{
    Cluster = "string",
    InstanceCrn = "string",
    ContainerIngressInstanceId = "string",
    IsDefault = false,
    SecretGroupId = "string",
    Timeouts = new Ibm.Inputs.ContainerIngressInstanceTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});
Copy
example, err := ibm.NewContainerIngressInstance(ctx, "containerIngressInstanceResource", &ibm.ContainerIngressInstanceArgs{
Cluster: pulumi.String("string"),
InstanceCrn: pulumi.String("string"),
ContainerIngressInstanceId: pulumi.String("string"),
IsDefault: pulumi.Bool(false),
SecretGroupId: pulumi.String("string"),
Timeouts: &.ContainerIngressInstanceTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
})
Copy
var containerIngressInstanceResource = new ContainerIngressInstance("containerIngressInstanceResource", ContainerIngressInstanceArgs.builder()
    .cluster("string")
    .instanceCrn("string")
    .containerIngressInstanceId("string")
    .isDefault(false)
    .secretGroupId("string")
    .timeouts(ContainerIngressInstanceTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());
Copy
container_ingress_instance_resource = ibm.ContainerIngressInstance("containerIngressInstanceResource",
    cluster="string",
    instance_crn="string",
    container_ingress_instance_id="string",
    is_default=False,
    secret_group_id="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })
Copy
const containerIngressInstanceResource = new ibm.ContainerIngressInstance("containerIngressInstanceResource", {
    cluster: "string",
    instanceCrn: "string",
    containerIngressInstanceId: "string",
    isDefault: false,
    secretGroupId: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});
Copy
type: ibm:ContainerIngressInstance
properties:
    cluster: string
    containerIngressInstanceId: string
    instanceCrn: string
    isDefault: false
    secretGroupId: string
    timeouts:
        create: string
        delete: string
        update: string
Copy

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

Cluster This property is required. string
The name of the cluster where the ALB is going to be created.
InstanceCrn This property is required. string
The CRN of the IBM Cloud Secrets Manager instance you want to register.
ContainerIngressInstanceId string
IsDefault bool
Marks the instance as the default instance for your cluster. The default ingress certificates will be uploaded to the default instance.
SecretGroupId string
If set, the default ingress certificates for the instance will be uploaded into this secret group in the instance.
Timeouts ContainerIngressInstanceTimeouts
Cluster This property is required. string
The name of the cluster where the ALB is going to be created.
InstanceCrn This property is required. string
The CRN of the IBM Cloud Secrets Manager instance you want to register.
ContainerIngressInstanceId string
IsDefault bool
Marks the instance as the default instance for your cluster. The default ingress certificates will be uploaded to the default instance.
SecretGroupId string
If set, the default ingress certificates for the instance will be uploaded into this secret group in the instance.
Timeouts ContainerIngressInstanceTimeoutsArgs
cluster This property is required. String
The name of the cluster where the ALB is going to be created.
instanceCrn This property is required. String
The CRN of the IBM Cloud Secrets Manager instance you want to register.
containerIngressInstanceId String
isDefault Boolean
Marks the instance as the default instance for your cluster. The default ingress certificates will be uploaded to the default instance.
secretGroupId String
If set, the default ingress certificates for the instance will be uploaded into this secret group in the instance.
timeouts ContainerIngressInstanceTimeouts
cluster This property is required. string
The name of the cluster where the ALB is going to be created.
instanceCrn This property is required. string
The CRN of the IBM Cloud Secrets Manager instance you want to register.
containerIngressInstanceId string
isDefault boolean
Marks the instance as the default instance for your cluster. The default ingress certificates will be uploaded to the default instance.
secretGroupId string
If set, the default ingress certificates for the instance will be uploaded into this secret group in the instance.
timeouts ContainerIngressInstanceTimeouts
cluster This property is required. str
The name of the cluster where the ALB is going to be created.
instance_crn This property is required. str
The CRN of the IBM Cloud Secrets Manager instance you want to register.
container_ingress_instance_id str
is_default bool
Marks the instance as the default instance for your cluster. The default ingress certificates will be uploaded to the default instance.
secret_group_id str
If set, the default ingress certificates for the instance will be uploaded into this secret group in the instance.
timeouts ContainerIngressInstanceTimeoutsArgs
cluster This property is required. String
The name of the cluster where the ALB is going to be created.
instanceCrn This property is required. String
The CRN of the IBM Cloud Secrets Manager instance you want to register.
containerIngressInstanceId String
isDefault Boolean
Marks the instance as the default instance for your cluster. The default ingress certificates will be uploaded to the default instance.
secretGroupId String
If set, the default ingress certificates for the instance will be uploaded into this secret group in the instance.
timeouts Property Map

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
InstanceName string
(String) The unique identifier of the instance. To retrieve run ibmcloud ks ingress instance ls for your cluster
InstanceType string
(String) Indicate whether the instance is of type Secrets Manager
SecretGroupName string
(String) The name of the secret group if set.
Status string
(String) Indicates the status of the instance registration.
UserManaged bool
(Bool) Indicates the user created and registered the instance.
Id string
The provider-assigned unique ID for this managed resource.
InstanceName string
(String) The unique identifier of the instance. To retrieve run ibmcloud ks ingress instance ls for your cluster
InstanceType string
(String) Indicate whether the instance is of type Secrets Manager
SecretGroupName string
(String) The name of the secret group if set.
Status string
(String) Indicates the status of the instance registration.
UserManaged bool
(Bool) Indicates the user created and registered the instance.
id String
The provider-assigned unique ID for this managed resource.
instanceName String
(String) The unique identifier of the instance. To retrieve run ibmcloud ks ingress instance ls for your cluster
instanceType String
(String) Indicate whether the instance is of type Secrets Manager
secretGroupName String
(String) The name of the secret group if set.
status String
(String) Indicates the status of the instance registration.
userManaged Boolean
(Bool) Indicates the user created and registered the instance.
id string
The provider-assigned unique ID for this managed resource.
instanceName string
(String) The unique identifier of the instance. To retrieve run ibmcloud ks ingress instance ls for your cluster
instanceType string
(String) Indicate whether the instance is of type Secrets Manager
secretGroupName string
(String) The name of the secret group if set.
status string
(String) Indicates the status of the instance registration.
userManaged boolean
(Bool) Indicates the user created and registered the instance.
id str
The provider-assigned unique ID for this managed resource.
instance_name str
(String) The unique identifier of the instance. To retrieve run ibmcloud ks ingress instance ls for your cluster
instance_type str
(String) Indicate whether the instance is of type Secrets Manager
secret_group_name str
(String) The name of the secret group if set.
status str
(String) Indicates the status of the instance registration.
user_managed bool
(Bool) Indicates the user created and registered the instance.
id String
The provider-assigned unique ID for this managed resource.
instanceName String
(String) The unique identifier of the instance. To retrieve run ibmcloud ks ingress instance ls for your cluster
instanceType String
(String) Indicate whether the instance is of type Secrets Manager
secretGroupName String
(String) The name of the secret group if set.
status String
(String) Indicates the status of the instance registration.
userManaged Boolean
(Bool) Indicates the user created and registered the instance.

Look up Existing ContainerIngressInstance Resource

Get an existing ContainerIngressInstance 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?: ContainerIngressInstanceState, opts?: CustomResourceOptions): ContainerIngressInstance
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster: Optional[str] = None,
        container_ingress_instance_id: Optional[str] = None,
        instance_crn: Optional[str] = None,
        instance_name: Optional[str] = None,
        instance_type: Optional[str] = None,
        is_default: Optional[bool] = None,
        secret_group_id: Optional[str] = None,
        secret_group_name: Optional[str] = None,
        status: Optional[str] = None,
        timeouts: Optional[ContainerIngressInstanceTimeoutsArgs] = None,
        user_managed: Optional[bool] = None) -> ContainerIngressInstance
func GetContainerIngressInstance(ctx *Context, name string, id IDInput, state *ContainerIngressInstanceState, opts ...ResourceOption) (*ContainerIngressInstance, error)
public static ContainerIngressInstance Get(string name, Input<string> id, ContainerIngressInstanceState? state, CustomResourceOptions? opts = null)
public static ContainerIngressInstance get(String name, Output<String> id, ContainerIngressInstanceState state, CustomResourceOptions options)
resources:  _:    type: ibm:ContainerIngressInstance    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Cluster string
The name of the cluster where the ALB is going to be created.
ContainerIngressInstanceId string
InstanceCrn string
The CRN of the IBM Cloud Secrets Manager instance you want to register.
InstanceName string
(String) The unique identifier of the instance. To retrieve run ibmcloud ks ingress instance ls for your cluster
InstanceType string
(String) Indicate whether the instance is of type Secrets Manager
IsDefault bool
Marks the instance as the default instance for your cluster. The default ingress certificates will be uploaded to the default instance.
SecretGroupId string
If set, the default ingress certificates for the instance will be uploaded into this secret group in the instance.
SecretGroupName string
(String) The name of the secret group if set.
Status string
(String) Indicates the status of the instance registration.
Timeouts ContainerIngressInstanceTimeouts
UserManaged bool
(Bool) Indicates the user created and registered the instance.
Cluster string
The name of the cluster where the ALB is going to be created.
ContainerIngressInstanceId string
InstanceCrn string
The CRN of the IBM Cloud Secrets Manager instance you want to register.
InstanceName string
(String) The unique identifier of the instance. To retrieve run ibmcloud ks ingress instance ls for your cluster
InstanceType string
(String) Indicate whether the instance is of type Secrets Manager
IsDefault bool
Marks the instance as the default instance for your cluster. The default ingress certificates will be uploaded to the default instance.
SecretGroupId string
If set, the default ingress certificates for the instance will be uploaded into this secret group in the instance.
SecretGroupName string
(String) The name of the secret group if set.
Status string
(String) Indicates the status of the instance registration.
Timeouts ContainerIngressInstanceTimeoutsArgs
UserManaged bool
(Bool) Indicates the user created and registered the instance.
cluster String
The name of the cluster where the ALB is going to be created.
containerIngressInstanceId String
instanceCrn String
The CRN of the IBM Cloud Secrets Manager instance you want to register.
instanceName String
(String) The unique identifier of the instance. To retrieve run ibmcloud ks ingress instance ls for your cluster
instanceType String
(String) Indicate whether the instance is of type Secrets Manager
isDefault Boolean
Marks the instance as the default instance for your cluster. The default ingress certificates will be uploaded to the default instance.
secretGroupId String
If set, the default ingress certificates for the instance will be uploaded into this secret group in the instance.
secretGroupName String
(String) The name of the secret group if set.
status String
(String) Indicates the status of the instance registration.
timeouts ContainerIngressInstanceTimeouts
userManaged Boolean
(Bool) Indicates the user created and registered the instance.
cluster string
The name of the cluster where the ALB is going to be created.
containerIngressInstanceId string
instanceCrn string
The CRN of the IBM Cloud Secrets Manager instance you want to register.
instanceName string
(String) The unique identifier of the instance. To retrieve run ibmcloud ks ingress instance ls for your cluster
instanceType string
(String) Indicate whether the instance is of type Secrets Manager
isDefault boolean
Marks the instance as the default instance for your cluster. The default ingress certificates will be uploaded to the default instance.
secretGroupId string
If set, the default ingress certificates for the instance will be uploaded into this secret group in the instance.
secretGroupName string
(String) The name of the secret group if set.
status string
(String) Indicates the status of the instance registration.
timeouts ContainerIngressInstanceTimeouts
userManaged boolean
(Bool) Indicates the user created and registered the instance.
cluster str
The name of the cluster where the ALB is going to be created.
container_ingress_instance_id str
instance_crn str
The CRN of the IBM Cloud Secrets Manager instance you want to register.
instance_name str
(String) The unique identifier of the instance. To retrieve run ibmcloud ks ingress instance ls for your cluster
instance_type str
(String) Indicate whether the instance is of type Secrets Manager
is_default bool
Marks the instance as the default instance for your cluster. The default ingress certificates will be uploaded to the default instance.
secret_group_id str
If set, the default ingress certificates for the instance will be uploaded into this secret group in the instance.
secret_group_name str
(String) The name of the secret group if set.
status str
(String) Indicates the status of the instance registration.
timeouts ContainerIngressInstanceTimeoutsArgs
user_managed bool
(Bool) Indicates the user created and registered the instance.
cluster String
The name of the cluster where the ALB is going to be created.
containerIngressInstanceId String
instanceCrn String
The CRN of the IBM Cloud Secrets Manager instance you want to register.
instanceName String
(String) The unique identifier of the instance. To retrieve run ibmcloud ks ingress instance ls for your cluster
instanceType String
(String) Indicate whether the instance is of type Secrets Manager
isDefault Boolean
Marks the instance as the default instance for your cluster. The default ingress certificates will be uploaded to the default instance.
secretGroupId String
If set, the default ingress certificates for the instance will be uploaded into this secret group in the instance.
secretGroupName String
(String) The name of the secret group if set.
status String
(String) Indicates the status of the instance registration.
timeouts Property Map
userManaged Boolean
(Bool) Indicates the user created and registered the instance.

Supporting Types

ContainerIngressInstanceTimeouts
, ContainerIngressInstanceTimeoutsArgs

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
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm