1. Packages
  2. Ibm Provider
  3. API Docs
  4. CisMtls
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.CisMtls

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

    Provides mutual TLS(mTLS) certificate settings resource. The resource allows to create(upload), update, or delete mTLS certificate settings of a domain of an IBM Cloud Internet Services CIS instance. For more information about mtls, see CIS MTLS.

    Create CisMtls Resource

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

    Constructor syntax

    new CisMtls(name: string, args: CisMtlsArgs, opts?: CustomResourceOptions);
    @overload
    def CisMtls(resource_name: str,
                args: CisMtlsArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def CisMtls(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                associated_hostnames: Optional[Sequence[str]] = None,
                certificate: Optional[str] = None,
                cis_id: Optional[str] = None,
                domain_id: Optional[str] = None,
                name: Optional[str] = None)
    func NewCisMtls(ctx *Context, name string, args CisMtlsArgs, opts ...ResourceOption) (*CisMtls, error)
    public CisMtls(string name, CisMtlsArgs args, CustomResourceOptions? opts = null)
    public CisMtls(String name, CisMtlsArgs args)
    public CisMtls(String name, CisMtlsArgs args, CustomResourceOptions options)
    
    type: ibm:CisMtls
    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 CisMtlsArgs
    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 CisMtlsArgs
    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 CisMtlsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CisMtlsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CisMtlsArgs
    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 cisMtlsResource = new Ibm.CisMtls("cisMtlsResource", new()
    {
        AssociatedHostnames = new[]
        {
            "string",
        },
        Certificate = "string",
        CisId = "string",
        DomainId = "string",
        Name = "string",
    });
    
    example, err := ibm.NewCisMtls(ctx, "cisMtlsResource", &ibm.CisMtlsArgs{
    	AssociatedHostnames: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Certificate: pulumi.String("string"),
    	CisId:       pulumi.String("string"),
    	DomainId:    pulumi.String("string"),
    	Name:        pulumi.String("string"),
    })
    
    var cisMtlsResource = new CisMtls("cisMtlsResource", CisMtlsArgs.builder()
        .associatedHostnames("string")
        .certificate("string")
        .cisId("string")
        .domainId("string")
        .name("string")
        .build());
    
    cis_mtls_resource = ibm.CisMtls("cisMtlsResource",
        associated_hostnames=["string"],
        certificate="string",
        cis_id="string",
        domain_id="string",
        name="string")
    
    const cisMtlsResource = new ibm.CisMtls("cisMtlsResource", {
        associatedHostnames: ["string"],
        certificate: "string",
        cisId: "string",
        domainId: "string",
        name: "string",
    });
    
    type: ibm:CisMtls
    properties:
        associatedHostnames:
            - string
        certificate: string
        cisId: string
        domainId: string
        name: string
    

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

    AssociatedHostnames List<string>
    Valid host names for which we want to add the certificate.
    Certificate string
    Content of valid MTLS certificate.
    CisId string
    The ID of the IBM Cloud Internet Services instance.
    DomainId string
    The ID of the domain to change cache settings.
    Name string
    Valid name for certificate.
    AssociatedHostnames []string
    Valid host names for which we want to add the certificate.
    Certificate string
    Content of valid MTLS certificate.
    CisId string
    The ID of the IBM Cloud Internet Services instance.
    DomainId string
    The ID of the domain to change cache settings.
    Name string
    Valid name for certificate.
    associatedHostnames List<String>
    Valid host names for which we want to add the certificate.
    certificate String
    Content of valid MTLS certificate.
    cisId String
    The ID of the IBM Cloud Internet Services instance.
    domainId String
    The ID of the domain to change cache settings.
    name String
    Valid name for certificate.
    associatedHostnames string[]
    Valid host names for which we want to add the certificate.
    certificate string
    Content of valid MTLS certificate.
    cisId string
    The ID of the IBM Cloud Internet Services instance.
    domainId string
    The ID of the domain to change cache settings.
    name string
    Valid name for certificate.
    associated_hostnames Sequence[str]
    Valid host names for which we want to add the certificate.
    certificate str
    Content of valid MTLS certificate.
    cis_id str
    The ID of the IBM Cloud Internet Services instance.
    domain_id str
    The ID of the domain to change cache settings.
    name str
    Valid name for certificate.
    associatedHostnames List<String>
    Valid host names for which we want to add the certificate.
    certificate String
    Content of valid MTLS certificate.
    cisId String
    The ID of the IBM Cloud Internet Services instance.
    domainId String
    The ID of the domain to change cache settings.
    name String
    Valid name for certificate.

    Outputs

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

    CreatedAt string
    (Computed, String) Time stamp string when Certificate is created'.
    ExpiresOn string
    (Computed, String) Time stamp string when Cerftificate expires on'.
    Id string
    The provider-assigned unique ID for this managed resource.
    MtlsId string
    (Computed, String) mTLS ID.
    UpdatedAt string
    (Computed, String) Time stamp string when Certificate is modified'.
    CreatedAt string
    (Computed, String) Time stamp string when Certificate is created'.
    ExpiresOn string
    (Computed, String) Time stamp string when Cerftificate expires on'.
    Id string
    The provider-assigned unique ID for this managed resource.
    MtlsId string
    (Computed, String) mTLS ID.
    UpdatedAt string
    (Computed, String) Time stamp string when Certificate is modified'.
    createdAt String
    (Computed, String) Time stamp string when Certificate is created'.
    expiresOn String
    (Computed, String) Time stamp string when Cerftificate expires on'.
    id String
    The provider-assigned unique ID for this managed resource.
    mtlsId String
    (Computed, String) mTLS ID.
    updatedAt String
    (Computed, String) Time stamp string when Certificate is modified'.
    createdAt string
    (Computed, String) Time stamp string when Certificate is created'.
    expiresOn string
    (Computed, String) Time stamp string when Cerftificate expires on'.
    id string
    The provider-assigned unique ID for this managed resource.
    mtlsId string
    (Computed, String) mTLS ID.
    updatedAt string
    (Computed, String) Time stamp string when Certificate is modified'.
    created_at str
    (Computed, String) Time stamp string when Certificate is created'.
    expires_on str
    (Computed, String) Time stamp string when Cerftificate expires on'.
    id str
    The provider-assigned unique ID for this managed resource.
    mtls_id str
    (Computed, String) mTLS ID.
    updated_at str
    (Computed, String) Time stamp string when Certificate is modified'.
    createdAt String
    (Computed, String) Time stamp string when Certificate is created'.
    expiresOn String
    (Computed, String) Time stamp string when Cerftificate expires on'.
    id String
    The provider-assigned unique ID for this managed resource.
    mtlsId String
    (Computed, String) mTLS ID.
    updatedAt String
    (Computed, String) Time stamp string when Certificate is modified'.

    Look up Existing CisMtls Resource

    Get an existing CisMtls 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?: CisMtlsState, opts?: CustomResourceOptions): CisMtls
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            associated_hostnames: Optional[Sequence[str]] = None,
            certificate: Optional[str] = None,
            cis_id: Optional[str] = None,
            created_at: Optional[str] = None,
            domain_id: Optional[str] = None,
            expires_on: Optional[str] = None,
            mtls_id: Optional[str] = None,
            name: Optional[str] = None,
            updated_at: Optional[str] = None) -> CisMtls
    func GetCisMtls(ctx *Context, name string, id IDInput, state *CisMtlsState, opts ...ResourceOption) (*CisMtls, error)
    public static CisMtls Get(string name, Input<string> id, CisMtlsState? state, CustomResourceOptions? opts = null)
    public static CisMtls get(String name, Output<String> id, CisMtlsState state, CustomResourceOptions options)
    resources:  _:    type: ibm:CisMtls    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:
    AssociatedHostnames List<string>
    Valid host names for which we want to add the certificate.
    Certificate string
    Content of valid MTLS certificate.
    CisId string
    The ID of the IBM Cloud Internet Services instance.
    CreatedAt string
    (Computed, String) Time stamp string when Certificate is created'.
    DomainId string
    The ID of the domain to change cache settings.
    ExpiresOn string
    (Computed, String) Time stamp string when Cerftificate expires on'.
    MtlsId string
    (Computed, String) mTLS ID.
    Name string
    Valid name for certificate.
    UpdatedAt string
    (Computed, String) Time stamp string when Certificate is modified'.
    AssociatedHostnames []string
    Valid host names for which we want to add the certificate.
    Certificate string
    Content of valid MTLS certificate.
    CisId string
    The ID of the IBM Cloud Internet Services instance.
    CreatedAt string
    (Computed, String) Time stamp string when Certificate is created'.
    DomainId string
    The ID of the domain to change cache settings.
    ExpiresOn string
    (Computed, String) Time stamp string when Cerftificate expires on'.
    MtlsId string
    (Computed, String) mTLS ID.
    Name string
    Valid name for certificate.
    UpdatedAt string
    (Computed, String) Time stamp string when Certificate is modified'.
    associatedHostnames List<String>
    Valid host names for which we want to add the certificate.
    certificate String
    Content of valid MTLS certificate.
    cisId String
    The ID of the IBM Cloud Internet Services instance.
    createdAt String
    (Computed, String) Time stamp string when Certificate is created'.
    domainId String
    The ID of the domain to change cache settings.
    expiresOn String
    (Computed, String) Time stamp string when Cerftificate expires on'.
    mtlsId String
    (Computed, String) mTLS ID.
    name String
    Valid name for certificate.
    updatedAt String
    (Computed, String) Time stamp string when Certificate is modified'.
    associatedHostnames string[]
    Valid host names for which we want to add the certificate.
    certificate string
    Content of valid MTLS certificate.
    cisId string
    The ID of the IBM Cloud Internet Services instance.
    createdAt string
    (Computed, String) Time stamp string when Certificate is created'.
    domainId string
    The ID of the domain to change cache settings.
    expiresOn string
    (Computed, String) Time stamp string when Cerftificate expires on'.
    mtlsId string
    (Computed, String) mTLS ID.
    name string
    Valid name for certificate.
    updatedAt string
    (Computed, String) Time stamp string when Certificate is modified'.
    associated_hostnames Sequence[str]
    Valid host names for which we want to add the certificate.
    certificate str
    Content of valid MTLS certificate.
    cis_id str
    The ID of the IBM Cloud Internet Services instance.
    created_at str
    (Computed, String) Time stamp string when Certificate is created'.
    domain_id str
    The ID of the domain to change cache settings.
    expires_on str
    (Computed, String) Time stamp string when Cerftificate expires on'.
    mtls_id str
    (Computed, String) mTLS ID.
    name str
    Valid name for certificate.
    updated_at str
    (Computed, String) Time stamp string when Certificate is modified'.
    associatedHostnames List<String>
    Valid host names for which we want to add the certificate.
    certificate String
    Content of valid MTLS certificate.
    cisId String
    The ID of the IBM Cloud Internet Services instance.
    createdAt String
    (Computed, String) Time stamp string when Certificate is created'.
    domainId String
    The ID of the domain to change cache settings.
    expiresOn String
    (Computed, String) Time stamp string when Cerftificate expires on'.
    mtlsId String
    (Computed, String) mTLS ID.
    name String
    Valid name for certificate.
    updatedAt String
    (Computed, String) Time stamp string when Certificate is modified'.

    Import

    The ibm_cis_mtls resource can be imported using the ID. The ID is formed from the mTLS ID, domain ID of the domain and the CRN concatenated using a : character.

    The domain ID and CRN will be located on the overview page of the IBM Cloud Internet Services instance of the console domain heading, or by using the ibmcloud cis command line commands.

    • MTLS ID is a string of the form: fa633cc7-4afc-4875-8814-b321153fee13

    • Domain ID is a 32 digit character string of the form: 9caf68812ae9b3f0377fdf986751a78f

    • CRN is a 120 digit character string of the form: crn:v1:bluemix:public:internet-svcs:global:a/4ea1882a2d3401ed1e459979941966ea:31fa970d-51d0-4b05-893e-251cba75a7b3::

    Syntax

    $ pulumi import ibm:index/cisMtls:CisMtls mtls_settings <mtlsid>:<domain-id>:<crn>
    

    Example

    $ pulumi import ibm:index/cisMtls:CisMtls mtls_settings fa633cc7-4afc-4875-8814-b321153fee13:9caf68812ae9b3f0377fdf986751a78f:crn:v1:bluemix:public:internet-svcs:global:a/4ea1882a2d3401ed1e459979941966ea:31fa970d-51d0-4b05-893e-251cba75a7b3::
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud