okta.Domain
Explore with Pulumi AI
Manages custom domain for your organization.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";
const example = new okta.Domain("example", {name: "www.example.com"});
import pulumi
import pulumi_okta as okta
example = okta.Domain("example", name="www.example.com")
package main
import (
"github.com/pulumi/pulumi-okta/sdk/v4/go/okta"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := okta.NewDomain(ctx, "example", &okta.DomainArgs{
Name: pulumi.String("www.example.com"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Okta = Pulumi.Okta;
return await Deployment.RunAsync(() =>
{
var example = new Okta.Domain("example", new()
{
Name = "www.example.com",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.Domain;
import com.pulumi.okta.DomainArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Domain("example", DomainArgs.builder()
.name("www.example.com")
.build());
}
}
resources:
example:
type: okta:Domain
properties:
name: www.example.com
Create Domain Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Domain(name: string, args?: DomainArgs, opts?: CustomResourceOptions);
@overload
def Domain(resource_name: str,
args: Optional[DomainArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Domain(resource_name: str,
opts: Optional[ResourceOptions] = None,
brand_id: Optional[str] = None,
certificate_source_type: Optional[str] = None,
name: Optional[str] = None)
func NewDomain(ctx *Context, name string, args *DomainArgs, opts ...ResourceOption) (*Domain, error)
public Domain(string name, DomainArgs? args = null, CustomResourceOptions? opts = null)
public Domain(String name, DomainArgs args)
public Domain(String name, DomainArgs args, CustomResourceOptions options)
type: okta:Domain
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 DomainArgs
- 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 DomainArgs
- 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 DomainArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DomainArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DomainArgs
- 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 domainResource = new Okta.Domain("domainResource", new()
{
BrandId = "string",
CertificateSourceType = "string",
Name = "string",
});
example, err := okta.NewDomain(ctx, "domainResource", &okta.DomainArgs{
BrandId: pulumi.String("string"),
CertificateSourceType: pulumi.String("string"),
Name: pulumi.String("string"),
})
var domainResource = new Domain("domainResource", DomainArgs.builder()
.brandId("string")
.certificateSourceType("string")
.name("string")
.build());
domain_resource = okta.Domain("domainResource",
brand_id="string",
certificate_source_type="string",
name="string")
const domainResource = new okta.Domain("domainResource", {
brandId: "string",
certificateSourceType: "string",
name: "string",
});
type: okta:Domain
properties:
brandId: string
certificateSourceType: string
name: string
Domain Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Domain resource accepts the following input properties:
- Brand
Id string - Brand id of the domain
- Certificate
Source stringType - Certificate source type that indicates whether the certificate is provided by the user or Okta. Accepted values:
MANUAL
,OKTA_MANAGED
. Warning: Use of OKTA_MANAGED requires a feature flag to be enabled. Default value = MANUAL - Name string
- Custom Domain name
- Brand
Id string - Brand id of the domain
- Certificate
Source stringType - Certificate source type that indicates whether the certificate is provided by the user or Okta. Accepted values:
MANUAL
,OKTA_MANAGED
. Warning: Use of OKTA_MANAGED requires a feature flag to be enabled. Default value = MANUAL - Name string
- Custom Domain name
- brand
Id String - Brand id of the domain
- certificate
Source StringType - Certificate source type that indicates whether the certificate is provided by the user or Okta. Accepted values:
MANUAL
,OKTA_MANAGED
. Warning: Use of OKTA_MANAGED requires a feature flag to be enabled. Default value = MANUAL - name String
- Custom Domain name
- brand
Id string - Brand id of the domain
- certificate
Source stringType - Certificate source type that indicates whether the certificate is provided by the user or Okta. Accepted values:
MANUAL
,OKTA_MANAGED
. Warning: Use of OKTA_MANAGED requires a feature flag to be enabled. Default value = MANUAL - name string
- Custom Domain name
- brand_
id str - Brand id of the domain
- certificate_
source_ strtype - Certificate source type that indicates whether the certificate is provided by the user or Okta. Accepted values:
MANUAL
,OKTA_MANAGED
. Warning: Use of OKTA_MANAGED requires a feature flag to be enabled. Default value = MANUAL - name str
- Custom Domain name
- brand
Id String - Brand id of the domain
- certificate
Source StringType - Certificate source type that indicates whether the certificate is provided by the user or Okta. Accepted values:
MANUAL
,OKTA_MANAGED
. Warning: Use of OKTA_MANAGED requires a feature flag to be enabled. Default value = MANUAL - name String
- Custom Domain name
Outputs
All input properties are implicitly available as output properties. Additionally, the Domain resource produces the following output properties:
- Dns
Records List<DomainDns Record> - TXT and CNAME records to be registered for the Domain
- Id string
- The provider-assigned unique ID for this managed resource.
- Validation
Status string - Status of the domain
- Dns
Records []DomainDns Record - TXT and CNAME records to be registered for the Domain
- Id string
- The provider-assigned unique ID for this managed resource.
- Validation
Status string - Status of the domain
- dns
Records List<DomainDns Record> - TXT and CNAME records to be registered for the Domain
- id String
- The provider-assigned unique ID for this managed resource.
- validation
Status String - Status of the domain
- dns
Records DomainDns Record[] - TXT and CNAME records to be registered for the Domain
- id string
- The provider-assigned unique ID for this managed resource.
- validation
Status string - Status of the domain
- dns_
records Sequence[DomainDns Record] - TXT and CNAME records to be registered for the Domain
- id str
- The provider-assigned unique ID for this managed resource.
- validation_
status str - Status of the domain
- dns
Records List<Property Map> - TXT and CNAME records to be registered for the Domain
- id String
- The provider-assigned unique ID for this managed resource.
- validation
Status String - Status of the domain
Look up Existing Domain Resource
Get an existing Domain 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?: DomainState, opts?: CustomResourceOptions): Domain
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
brand_id: Optional[str] = None,
certificate_source_type: Optional[str] = None,
dns_records: Optional[Sequence[DomainDnsRecordArgs]] = None,
name: Optional[str] = None,
validation_status: Optional[str] = None) -> Domain
func GetDomain(ctx *Context, name string, id IDInput, state *DomainState, opts ...ResourceOption) (*Domain, error)
public static Domain Get(string name, Input<string> id, DomainState? state, CustomResourceOptions? opts = null)
public static Domain get(String name, Output<String> id, DomainState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Brand
Id string - Brand id of the domain
- Certificate
Source stringType - Certificate source type that indicates whether the certificate is provided by the user or Okta. Accepted values:
MANUAL
,OKTA_MANAGED
. Warning: Use of OKTA_MANAGED requires a feature flag to be enabled. Default value = MANUAL - Dns
Records List<DomainDns Record> - TXT and CNAME records to be registered for the Domain
- Name string
- Custom Domain name
- Validation
Status string - Status of the domain
- Brand
Id string - Brand id of the domain
- Certificate
Source stringType - Certificate source type that indicates whether the certificate is provided by the user or Okta. Accepted values:
MANUAL
,OKTA_MANAGED
. Warning: Use of OKTA_MANAGED requires a feature flag to be enabled. Default value = MANUAL - Dns
Records []DomainDns Record Args - TXT and CNAME records to be registered for the Domain
- Name string
- Custom Domain name
- Validation
Status string - Status of the domain
- brand
Id String - Brand id of the domain
- certificate
Source StringType - Certificate source type that indicates whether the certificate is provided by the user or Okta. Accepted values:
MANUAL
,OKTA_MANAGED
. Warning: Use of OKTA_MANAGED requires a feature flag to be enabled. Default value = MANUAL - dns
Records List<DomainDns Record> - TXT and CNAME records to be registered for the Domain
- name String
- Custom Domain name
- validation
Status String - Status of the domain
- brand
Id string - Brand id of the domain
- certificate
Source stringType - Certificate source type that indicates whether the certificate is provided by the user or Okta. Accepted values:
MANUAL
,OKTA_MANAGED
. Warning: Use of OKTA_MANAGED requires a feature flag to be enabled. Default value = MANUAL - dns
Records DomainDns Record[] - TXT and CNAME records to be registered for the Domain
- name string
- Custom Domain name
- validation
Status string - Status of the domain
- brand_
id str - Brand id of the domain
- certificate_
source_ strtype - Certificate source type that indicates whether the certificate is provided by the user or Okta. Accepted values:
MANUAL
,OKTA_MANAGED
. Warning: Use of OKTA_MANAGED requires a feature flag to be enabled. Default value = MANUAL - dns_
records Sequence[DomainDns Record Args] - TXT and CNAME records to be registered for the Domain
- name str
- Custom Domain name
- validation_
status str - Status of the domain
- brand
Id String - Brand id of the domain
- certificate
Source StringType - Certificate source type that indicates whether the certificate is provided by the user or Okta. Accepted values:
MANUAL
,OKTA_MANAGED
. Warning: Use of OKTA_MANAGED requires a feature flag to be enabled. Default value = MANUAL - dns
Records List<Property Map> - TXT and CNAME records to be registered for the Domain
- name String
- Custom Domain name
- validation
Status String - Status of the domain
Supporting Types
DomainDnsRecord, DomainDnsRecordArgs
- Expiration string
- TXT record expiration
- Fqdn string
- DNS record name
- Record
Type string - Record type can be TXT or CNAME
- Values List<string>
- DNS verification value
- Expiration string
- TXT record expiration
- Fqdn string
- DNS record name
- Record
Type string - Record type can be TXT or CNAME
- Values []string
- DNS verification value
- expiration String
- TXT record expiration
- fqdn String
- DNS record name
- record
Type String - Record type can be TXT or CNAME
- values List<String>
- DNS verification value
- expiration string
- TXT record expiration
- fqdn string
- DNS record name
- record
Type string - Record type can be TXT or CNAME
- values string[]
- DNS verification value
- expiration str
- TXT record expiration
- fqdn str
- DNS record name
- record_
type str - Record type can be TXT or CNAME
- values Sequence[str]
- DNS verification value
- expiration String
- TXT record expiration
- fqdn String
- DNS record name
- record
Type String - Record type can be TXT or CNAME
- values List<String>
- DNS verification value
Import
$ pulumi import okta:index/domain:Domain example <domain_id>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Okta pulumi/pulumi-okta
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
okta
Terraform Provider.