Docs Home
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm.CisOriginAuth
Explore with Pulumi AI
Provides origin auth settings resource. The resource allows to create, update, or delete cache settings of a domain of an IBM Cloud Internet Services CIS instance. For more information about CIS origin auth, see CIS ORIGIN AUTH.
Create CisOriginAuth Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CisOriginAuth(name: string, args: CisOriginAuthArgs, opts?: CustomResourceOptions);@overload
def CisOriginAuth(resource_name: str,
args: CisOriginAuthArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CisOriginAuth(resource_name: str,
opts: Optional[ResourceOptions] = None,
certificate: Optional[str] = None,
cis_id: Optional[str] = None,
domain_id: Optional[str] = None,
level: Optional[str] = None,
private_key: Optional[str] = None,
cis_origin_auth_id: Optional[str] = None,
enabled: Optional[bool] = None,
hostname: Optional[str] = None)func NewCisOriginAuth(ctx *Context, name string, args CisOriginAuthArgs, opts ...ResourceOption) (*CisOriginAuth, error)public CisOriginAuth(string name, CisOriginAuthArgs args, CustomResourceOptions? opts = null)
public CisOriginAuth(String name, CisOriginAuthArgs args)
public CisOriginAuth(String name, CisOriginAuthArgs args, CustomResourceOptions options)
type: ibm:CisOriginAuth
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 CisOriginAuthArgs
- 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 CisOriginAuthArgs
- 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 CisOriginAuthArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CisOriginAuthArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CisOriginAuthArgs
- 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 cisOriginAuthResource = new Ibm.CisOriginAuth("cisOriginAuthResource", new()
{
Certificate = "string",
CisId = "string",
DomainId = "string",
Level = "string",
PrivateKey = "string",
CisOriginAuthId = "string",
Enabled = false,
Hostname = "string",
});
example, err := ibm.NewCisOriginAuth(ctx, "cisOriginAuthResource", &ibm.CisOriginAuthArgs{
Certificate: pulumi.String("string"),
CisId: pulumi.String("string"),
DomainId: pulumi.String("string"),
Level: pulumi.String("string"),
PrivateKey: pulumi.String("string"),
CisOriginAuthId: pulumi.String("string"),
Enabled: pulumi.Bool(false),
Hostname: pulumi.String("string"),
})
var cisOriginAuthResource = new CisOriginAuth("cisOriginAuthResource", CisOriginAuthArgs.builder()
.certificate("string")
.cisId("string")
.domainId("string")
.level("string")
.privateKey("string")
.cisOriginAuthId("string")
.enabled(false)
.hostname("string")
.build());
cis_origin_auth_resource = ibm.CisOriginAuth("cisOriginAuthResource",
certificate="string",
cis_id="string",
domain_id="string",
level="string",
private_key="string",
cis_origin_auth_id="string",
enabled=False,
hostname="string")
const cisOriginAuthResource = new ibm.CisOriginAuth("cisOriginAuthResource", {
certificate: "string",
cisId: "string",
domainId: "string",
level: "string",
privateKey: "string",
cisOriginAuthId: "string",
enabled: false,
hostname: "string",
});
type: ibm:CisOriginAuth
properties:
certificate: string
cisId: string
cisOriginAuthId: string
domainId: string
enabled: false
hostname: string
level: string
privateKey: string
CisOriginAuth 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 CisOriginAuth resource accepts the following input properties:
- Certificate string
- Content of certificate.
- Cis
Id string - The ID of the IBM Cloud Internet Services instance.
- Domain
Id string - The ID of the domain to change cache settings.
- Level string
- Origin auth level zone or hostname
- Private
Key string - Content of private key. # pragma: whitelist secret.
level- (Required, String) Origin Auth setting level zone or hostname.
- Cis
Origin stringAuth Id - (Computed, String) The record ID. It is a combination of
<auth_id>,<level>,<domain_id>,<cis_id>attributes concatenated with:. - Enabled bool
- Default is true, it enables/disables the host and zone level origin auth setting.
- Hostname string
- Valid host names for host level origin auth processing.
- Certificate string
- Content of certificate.
- Cis
Id string - The ID of the IBM Cloud Internet Services instance.
- Domain
Id string - The ID of the domain to change cache settings.
- Level string
- Origin auth level zone or hostname
- Private
Key string - Content of private key. # pragma: whitelist secret.
level- (Required, String) Origin Auth setting level zone or hostname.
- Cis
Origin stringAuth Id - (Computed, String) The record ID. It is a combination of
<auth_id>,<level>,<domain_id>,<cis_id>attributes concatenated with:. - Enabled bool
- Default is true, it enables/disables the host and zone level origin auth setting.
- Hostname string
- Valid host names for host level origin auth processing.
- certificate String
- Content of certificate.
- cis
Id String - The ID of the IBM Cloud Internet Services instance.
- domain
Id String - The ID of the domain to change cache settings.
- level String
- Origin auth level zone or hostname
- private
Key String - Content of private key. # pragma: whitelist secret.
level- (Required, String) Origin Auth setting level zone or hostname.
- cis
Origin StringAuth Id - (Computed, String) The record ID. It is a combination of
<auth_id>,<level>,<domain_id>,<cis_id>attributes concatenated with:. - enabled Boolean
- Default is true, it enables/disables the host and zone level origin auth setting.
- hostname String
- Valid host names for host level origin auth processing.
- certificate string
- Content of certificate.
- cis
Id string - The ID of the IBM Cloud Internet Services instance.
- domain
Id string - The ID of the domain to change cache settings.
- level string
- Origin auth level zone or hostname
- private
Key string - Content of private key. # pragma: whitelist secret.
level- (Required, String) Origin Auth setting level zone or hostname.
- cis
Origin stringAuth Id - (Computed, String) The record ID. It is a combination of
<auth_id>,<level>,<domain_id>,<cis_id>attributes concatenated with:. - enabled boolean
- Default is true, it enables/disables the host and zone level origin auth setting.
- hostname string
- Valid host names for host level origin auth processing.
- certificate str
- Content of 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.
- level str
- Origin auth level zone or hostname
- private_
key str - Content of private key. # pragma: whitelist secret.
level- (Required, String) Origin Auth setting level zone or hostname.
- cis_
origin_ strauth_ id - (Computed, String) The record ID. It is a combination of
<auth_id>,<level>,<domain_id>,<cis_id>attributes concatenated with:. - enabled bool
- Default is true, it enables/disables the host and zone level origin auth setting.
- hostname str
- Valid host names for host level origin auth processing.
- certificate String
- Content of certificate.
- cis
Id String - The ID of the IBM Cloud Internet Services instance.
- domain
Id String - The ID of the domain to change cache settings.
- level String
- Origin auth level zone or hostname
- private
Key String - Content of private key. # pragma: whitelist secret.
level- (Required, String) Origin Auth setting level zone or hostname.
- cis
Origin StringAuth Id - (Computed, String) The record ID. It is a combination of
<auth_id>,<level>,<domain_id>,<cis_id>attributes concatenated with:. - enabled Boolean
- Default is true, it enables/disables the host and zone level origin auth setting.
- hostname String
- Valid host names for host level origin auth processing.
Outputs
All input properties are implicitly available as output properties. Additionally, the CisOriginAuth resource produces the following output properties:
- Auth
Id string - Associated CIS auth pull job id
- Cert
Id string - (Computed, String) Uploaded certificate ID.
- Expires
On string - (Computed, String) Time stamp string when Cerftificate expires on'.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status string
- (Computed, String) Origin auth status enbled or not.
- Uploaded
On string - Certificate uploaded on
- Auth
Id string - Associated CIS auth pull job id
- Cert
Id string - (Computed, String) Uploaded certificate ID.
- Expires
On string - (Computed, String) Time stamp string when Cerftificate expires on'.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status string
- (Computed, String) Origin auth status enbled or not.
- Uploaded
On string - Certificate uploaded on
- auth
Id String - Associated CIS auth pull job id
- cert
Id String - (Computed, String) Uploaded certificate ID.
- expires
On String - (Computed, String) Time stamp string when Cerftificate expires on'.
- id String
- The provider-assigned unique ID for this managed resource.
- status String
- (Computed, String) Origin auth status enbled or not.
- uploaded
On String - Certificate uploaded on
- auth
Id string - Associated CIS auth pull job id
- cert
Id string - (Computed, String) Uploaded certificate ID.
- expires
On string - (Computed, String) Time stamp string when Cerftificate expires on'.
- id string
- The provider-assigned unique ID for this managed resource.
- status string
- (Computed, String) Origin auth status enbled or not.
- uploaded
On string - Certificate uploaded on
- auth_
id str - Associated CIS auth pull job id
- cert_
id str - (Computed, String) Uploaded certificate ID.
- expires_
on str - (Computed, String) Time stamp string when Cerftificate expires on'.
- id str
- The provider-assigned unique ID for this managed resource.
- status str
- (Computed, String) Origin auth status enbled or not.
- uploaded_
on str - Certificate uploaded on
- auth
Id String - Associated CIS auth pull job id
- cert
Id String - (Computed, String) Uploaded certificate ID.
- expires
On String - (Computed, String) Time stamp string when Cerftificate expires on'.
- id String
- The provider-assigned unique ID for this managed resource.
- status String
- (Computed, String) Origin auth status enbled or not.
- uploaded
On String - Certificate uploaded on
Look up Existing CisOriginAuth Resource
Get an existing CisOriginAuth 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?: CisOriginAuthState, opts?: CustomResourceOptions): CisOriginAuth@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
auth_id: Optional[str] = None,
cert_id: Optional[str] = None,
certificate: Optional[str] = None,
cis_id: Optional[str] = None,
cis_origin_auth_id: Optional[str] = None,
domain_id: Optional[str] = None,
enabled: Optional[bool] = None,
expires_on: Optional[str] = None,
hostname: Optional[str] = None,
level: Optional[str] = None,
private_key: Optional[str] = None,
status: Optional[str] = None,
uploaded_on: Optional[str] = None) -> CisOriginAuthfunc GetCisOriginAuth(ctx *Context, name string, id IDInput, state *CisOriginAuthState, opts ...ResourceOption) (*CisOriginAuth, error)public static CisOriginAuth Get(string name, Input<string> id, CisOriginAuthState? state, CustomResourceOptions? opts = null)public static CisOriginAuth get(String name, Output<String> id, CisOriginAuthState state, CustomResourceOptions options)resources: _: type: ibm:CisOriginAuth 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.
- Auth
Id string - Associated CIS auth pull job id
- Cert
Id string - (Computed, String) Uploaded certificate ID.
- Certificate string
- Content of certificate.
- Cis
Id string - The ID of the IBM Cloud Internet Services instance.
- Cis
Origin stringAuth Id - (Computed, String) The record ID. It is a combination of
<auth_id>,<level>,<domain_id>,<cis_id>attributes concatenated with:. - Domain
Id string - The ID of the domain to change cache settings.
- Enabled bool
- Default is true, it enables/disables the host and zone level origin auth setting.
- Expires
On string - (Computed, String) Time stamp string when Cerftificate expires on'.
- Hostname string
- Valid host names for host level origin auth processing.
- Level string
- Origin auth level zone or hostname
- Private
Key string - Content of private key. # pragma: whitelist secret.
level- (Required, String) Origin Auth setting level zone or hostname.
- Status string
- (Computed, String) Origin auth status enbled or not.
- Uploaded
On string - Certificate uploaded on
- Auth
Id string - Associated CIS auth pull job id
- Cert
Id string - (Computed, String) Uploaded certificate ID.
- Certificate string
- Content of certificate.
- Cis
Id string - The ID of the IBM Cloud Internet Services instance.
- Cis
Origin stringAuth Id - (Computed, String) The record ID. It is a combination of
<auth_id>,<level>,<domain_id>,<cis_id>attributes concatenated with:. - Domain
Id string - The ID of the domain to change cache settings.
- Enabled bool
- Default is true, it enables/disables the host and zone level origin auth setting.
- Expires
On string - (Computed, String) Time stamp string when Cerftificate expires on'.
- Hostname string
- Valid host names for host level origin auth processing.
- Level string
- Origin auth level zone or hostname
- Private
Key string - Content of private key. # pragma: whitelist secret.
level- (Required, String) Origin Auth setting level zone or hostname.
- Status string
- (Computed, String) Origin auth status enbled or not.
- Uploaded
On string - Certificate uploaded on
- auth
Id String - Associated CIS auth pull job id
- cert
Id String - (Computed, String) Uploaded certificate ID.
- certificate String
- Content of certificate.
- cis
Id String - The ID of the IBM Cloud Internet Services instance.
- cis
Origin StringAuth Id - (Computed, String) The record ID. It is a combination of
<auth_id>,<level>,<domain_id>,<cis_id>attributes concatenated with:. - domain
Id String - The ID of the domain to change cache settings.
- enabled Boolean
- Default is true, it enables/disables the host and zone level origin auth setting.
- expires
On String - (Computed, String) Time stamp string when Cerftificate expires on'.
- hostname String
- Valid host names for host level origin auth processing.
- level String
- Origin auth level zone or hostname
- private
Key String - Content of private key. # pragma: whitelist secret.
level- (Required, String) Origin Auth setting level zone or hostname.
- status String
- (Computed, String) Origin auth status enbled or not.
- uploaded
On String - Certificate uploaded on
- auth
Id string - Associated CIS auth pull job id
- cert
Id string - (Computed, String) Uploaded certificate ID.
- certificate string
- Content of certificate.
- cis
Id string - The ID of the IBM Cloud Internet Services instance.
- cis
Origin stringAuth Id - (Computed, String) The record ID. It is a combination of
<auth_id>,<level>,<domain_id>,<cis_id>attributes concatenated with:. - domain
Id string - The ID of the domain to change cache settings.
- enabled boolean
- Default is true, it enables/disables the host and zone level origin auth setting.
- expires
On string - (Computed, String) Time stamp string when Cerftificate expires on'.
- hostname string
- Valid host names for host level origin auth processing.
- level string
- Origin auth level zone or hostname
- private
Key string - Content of private key. # pragma: whitelist secret.
level- (Required, String) Origin Auth setting level zone or hostname.
- status string
- (Computed, String) Origin auth status enbled or not.
- uploaded
On string - Certificate uploaded on
- auth_
id str - Associated CIS auth pull job id
- cert_
id str - (Computed, String) Uploaded certificate ID.
- certificate str
- Content of certificate.
- cis_
id str - The ID of the IBM Cloud Internet Services instance.
- cis_
origin_ strauth_ id - (Computed, String) The record ID. It is a combination of
<auth_id>,<level>,<domain_id>,<cis_id>attributes concatenated with:. - domain_
id str - The ID of the domain to change cache settings.
- enabled bool
- Default is true, it enables/disables the host and zone level origin auth setting.
- expires_
on str - (Computed, String) Time stamp string when Cerftificate expires on'.
- hostname str
- Valid host names for host level origin auth processing.
- level str
- Origin auth level zone or hostname
- private_
key str - Content of private key. # pragma: whitelist secret.
level- (Required, String) Origin Auth setting level zone or hostname.
- status str
- (Computed, String) Origin auth status enbled or not.
- uploaded_
on str - Certificate uploaded on
- auth
Id String - Associated CIS auth pull job id
- cert
Id String - (Computed, String) Uploaded certificate ID.
- certificate String
- Content of certificate.
- cis
Id String - The ID of the IBM Cloud Internet Services instance.
- cis
Origin StringAuth Id - (Computed, String) The record ID. It is a combination of
<auth_id>,<level>,<domain_id>,<cis_id>attributes concatenated with:. - domain
Id String - The ID of the domain to change cache settings.
- enabled Boolean
- Default is true, it enables/disables the host and zone level origin auth setting.
- expires
On String - (Computed, String) Time stamp string when Cerftificate expires on'.
- hostname String
- Valid host names for host level origin auth processing.
- level String
- Origin auth level zone or hostname
- private
Key String - Content of private key. # pragma: whitelist secret.
level- (Required, String) Origin Auth setting level zone or hostname.
- status String
- (Computed, String) Origin auth status enbled or not.
- uploaded
On String - Certificate uploaded on
Import
The ibm_cis_origin_auth resource can be imported using the ID. The ID is formed from auth ID, level, the 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.
Auth ID is a string of the form:
fa633cc7-4afc-4875-8814-b321153fee13Level is a string of the form:
zoneDomain ID is a 32 digit character string of the form:
9caf68812ae9b3f0377fdf986751a78fCRN 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/cisOriginAuth:CisOriginAuth origin_auth_settings <auth_id>:<level>:<domain-id>:<crn>
Example
$ pulumi import ibm:index/cisOriginAuth:CisOriginAuth origin_auth_settings fa633cc7-4afc-4875-8814-b321153fee13:zone: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
ibmTerraform Provider.