Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Control Plane (cpln)
  3. API Docs
  4. Domain
Control Plane v0.0.47 published on Saturday, Nov 9, 2024 by pulumiverse
pulumiverse/pulumi-cpln

cpln.Domain

Explore with Pulumi AI

cpln logo
Control Plane v0.0.47 published on Saturday, Nov 9, 2024 by pulumiverse
pulumiverse/pulumi-cpln

    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: DomainArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Domain(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           spec: Optional[DomainSpecArgs] = None,
           description: Optional[str] = None,
           name: Optional[str] = None,
           tags: Optional[Mapping[str, str]] = None)
    func NewDomain(ctx *Context, name string, args DomainArgs, opts ...ResourceOption) (*Domain, error)
    public Domain(string name, DomainArgs args, CustomResourceOptions? opts = null)
    public Domain(String name, DomainArgs args)
public Domain(String name, DomainArgs args, CustomResourceOptions options)

    type: cpln: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 Cpln.Domain("domainResource", new()
{
    Spec = new Cpln.Inputs.DomainSpecArgs
    {
        Ports = new[]
        {
            new Cpln.Inputs.DomainSpecPortArgs
            {
                Tls = new Cpln.Inputs.DomainSpecPortTlsArgs
                {
                    CipherSuites = new[]
                    {
                        "string",
                    },
                    ClientCertificate = new Cpln.Inputs.DomainSpecPortTlsClientCertificateArgs
                    {
                        SecretLink = "string",
                    },
                    MinProtocolVersion = "string",
                    ServerCertificate = new Cpln.Inputs.DomainSpecPortTlsServerCertificateArgs
                    {
                        SecretLink = "string",
                    },
                },
                Cors = new Cpln.Inputs.DomainSpecPortCorsArgs
                {
                    AllowCredentials = false,
                    AllowHeaders = new[]
                    {
                        "string",
                    },
                    AllowMethods = new[]
                    {
                        "string",
                    },
                    AllowOrigins = new[]
                    {
                        new Cpln.Inputs.DomainSpecPortCorsAllowOriginArgs
                        {
                            Exact = "string",
                        },
                    },
                    ExposeHeaders = new[]
                    {
                        "string",
                    },
                    MaxAge = "string",
                },
                Number = 0,
                Protocol = "string",
            },
        },
        AcceptAllHosts = false,
        DnsMode = "string",
        GvcLink = "string",
    },
    Description = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := cpln.NewDomain(ctx, "domainResource", &cpln.DomainArgs{
	Spec: &cpln.DomainSpecArgs{
		Ports: cpln.DomainSpecPortArray{
			&cpln.DomainSpecPortArgs{
				Tls: &cpln.DomainSpecPortTlsArgs{
					CipherSuites: pulumi.StringArray{
						pulumi.String("string"),
					},
					ClientCertificate: &cpln.DomainSpecPortTlsClientCertificateArgs{
						SecretLink: pulumi.String("string"),
					},
					MinProtocolVersion: pulumi.String("string"),
					ServerCertificate: &cpln.DomainSpecPortTlsServerCertificateArgs{
						SecretLink: pulumi.String("string"),
					},
				},
				Cors: &cpln.DomainSpecPortCorsArgs{
					AllowCredentials: pulumi.Bool(false),
					AllowHeaders: pulumi.StringArray{
						pulumi.String("string"),
					},
					AllowMethods: pulumi.StringArray{
						pulumi.String("string"),
					},
					AllowOrigins: cpln.DomainSpecPortCorsAllowOriginArray{
						&cpln.DomainSpecPortCorsAllowOriginArgs{
							Exact: pulumi.String("string"),
						},
					},
					ExposeHeaders: pulumi.StringArray{
						pulumi.String("string"),
					},
					MaxAge: pulumi.String("string"),
				},
				Number:   pulumi.Int(0),
				Protocol: pulumi.String("string"),
			},
		},
		AcceptAllHosts: pulumi.Bool(false),
		DnsMode:        pulumi.String("string"),
		GvcLink:        pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var domainResource = new Domain("domainResource", DomainArgs.builder()
    .spec(DomainSpecArgs.builder()
        .ports(DomainSpecPortArgs.builder()
            .tls(DomainSpecPortTlsArgs.builder()
                .cipherSuites("string")
                .clientCertificate(DomainSpecPortTlsClientCertificateArgs.builder()
                    .secretLink("string")
                    .build())
                .minProtocolVersion("string")
                .serverCertificate(DomainSpecPortTlsServerCertificateArgs.builder()
                    .secretLink("string")
                    .build())
                .build())
            .cors(DomainSpecPortCorsArgs.builder()
                .allowCredentials(false)
                .allowHeaders("string")
                .allowMethods("string")
                .allowOrigins(DomainSpecPortCorsAllowOriginArgs.builder()
                    .exact("string")
                    .build())
                .exposeHeaders("string")
                .maxAge("string")
                .build())
            .number(0)
            .protocol("string")
            .build())
        .acceptAllHosts(false)
        .dnsMode("string")
        .gvcLink("string")
        .build())
    .description("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    domain_resource = cpln.Domain("domainResource",
    spec={
        "ports": [{
            "tls": {
                "cipher_suites": ["string"],
                "client_certificate": {
                    "secret_link": "string",
                },
                "min_protocol_version": "string",
                "server_certificate": {
                    "secret_link": "string",
                },
            },
            "cors": {
                "allow_credentials": False,
                "allow_headers": ["string"],
                "allow_methods": ["string"],
                "allow_origins": [{
                    "exact": "string",
                }],
                "expose_headers": ["string"],
                "max_age": "string",
            },
            "number": 0,
            "protocol": "string",
        }],
        "accept_all_hosts": False,
        "dns_mode": "string",
        "gvc_link": "string",
    },
    description="string",
    name="string",
    tags={
        "string": "string",
    })

    const domainResource = new cpln.Domain("domainResource", {
    spec: {
        ports: [{
            tls: {
                cipherSuites: ["string"],
                clientCertificate: {
                    secretLink: "string",
                },
                minProtocolVersion: "string",
                serverCertificate: {
                    secretLink: "string",
                },
            },
            cors: {
                allowCredentials: false,
                allowHeaders: ["string"],
                allowMethods: ["string"],
                allowOrigins: [{
                    exact: "string",
                }],
                exposeHeaders: ["string"],
                maxAge: "string",
            },
            number: 0,
            protocol: "string",
        }],
        acceptAllHosts: false,
        dnsMode: "string",
        gvcLink: "string",
    },
    description: "string",
    name: "string",
    tags: {
        string: "string",
    },
});

    type: cpln:Domain
properties:
    description: string
    name: string
    spec:
        acceptAllHosts: false
        dnsMode: string
        gvcLink: string
        ports:
            - cors:
                allowCredentials: false
                allowHeaders:
                    - string
                allowMethods:
                    - string
                allowOrigins:
                    - exact: string
                exposeHeaders:
                    - string
                maxAge: string
              number: 0
              protocol: string
              tls:
                cipherSuites:
                    - string
                clientCertificate:
                    secretLink: string
                minProtocolVersion: string
                serverCertificate:
                    secretLink: string
    tags:
        string: 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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Domain resource accepts the following input properties:

    Spec Pulumiverse.Cpln.Inputs.DomainSpec
    Domain specification.
    Description string
    Description of the domain name.
    Name string
    Domain name. (e.g., example.com / test.example.com). Control Plane will validate the existence of the domain with DNS. Create and Update will fail if the required DNS entries cannot be validated.
    Tags Dictionary<string, string>
    Key-value map of resource tags.
    Spec DomainSpecArgs
    Domain specification.
    Description string
    Description of the domain name.
    Name string
    Domain name. (e.g., example.com / test.example.com). Control Plane will validate the existence of the domain with DNS. Create and Update will fail if the required DNS entries cannot be validated.
    Tags map[string]string
    Key-value map of resource tags.
    spec DomainSpec
    Domain specification.
    description String
    Description of the domain name.
    name String
    Domain name. (e.g., example.com / test.example.com). Control Plane will validate the existence of the domain with DNS. Create and Update will fail if the required DNS entries cannot be validated.
    tags Map<String,String>
    Key-value map of resource tags.
    spec DomainSpec
    Domain specification.
    description string
    Description of the domain name.
    name string
    Domain name. (e.g., example.com / test.example.com). Control Plane will validate the existence of the domain with DNS. Create and Update will fail if the required DNS entries cannot be validated.
    tags {[key: string]: string}
    Key-value map of resource tags.
    spec DomainSpecArgs
    Domain specification.
    description str
    Description of the domain name.
    name str
    Domain name. (e.g., example.com / test.example.com). Control Plane will validate the existence of the domain with DNS. Create and Update will fail if the required DNS entries cannot be validated.
    tags Mapping[str, str]
    Key-value map of resource tags.
    spec Property Map
    Domain specification.
    description String
    Description of the domain name.
    name String
    Domain name. (e.g., example.com / test.example.com). Control Plane will validate the existence of the domain with DNS. Create and Update will fail if the required DNS entries cannot be validated.
    tags Map<String>
    Key-value map of resource tags.

    Outputs

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

    CplnId string
    The ID, in GUID format, of the Domain.
    Id string
    The provider-assigned unique ID for this managed resource.
    SelfLink string
    Full link to this resource. Can be referenced by other resources.
    Statuses List<Pulumiverse.Cpln.Outputs.DomainStatus>
    CplnId string
    The ID, in GUID format, of the Domain.
    Id string
    The provider-assigned unique ID for this managed resource.
    SelfLink string
    Full link to this resource. Can be referenced by other resources.
    Statuses []DomainStatus
    cplnId String
    The ID, in GUID format, of the Domain.
    id String
    The provider-assigned unique ID for this managed resource.
    selfLink String
    Full link to this resource. Can be referenced by other resources.
    statuses List<DomainStatus>
    cplnId string
    The ID, in GUID format, of the Domain.
    id string
    The provider-assigned unique ID for this managed resource.
    selfLink string
    Full link to this resource. Can be referenced by other resources.
    statuses DomainStatus[]
    cpln_id str
    The ID, in GUID format, of the Domain.
    id str
    The provider-assigned unique ID for this managed resource.
    self_link str
    Full link to this resource. Can be referenced by other resources.
    statuses Sequence[DomainStatus]
    cplnId String
    The ID, in GUID format, of the Domain.
    id String
    The provider-assigned unique ID for this managed resource.
    selfLink String
    Full link to this resource. Can be referenced by other resources.
    statuses List<Property Map>

    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,
        cpln_id: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        self_link: Optional[str] = None,
        spec: Optional[DomainSpecArgs] = None,
        statuses: Optional[Sequence[DomainStatusArgs]] = None,
        tags: Optional[Mapping[str, 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.
    The following state arguments are supported:
    CplnId string
    The ID, in GUID format, of the Domain.
    Description string
    Description of the domain name.
    Name string
    Domain name. (e.g., example.com / test.example.com). Control Plane will validate the existence of the domain with DNS. Create and Update will fail if the required DNS entries cannot be validated.
    SelfLink string
    Full link to this resource. Can be referenced by other resources.
    Spec Pulumiverse.Cpln.Inputs.DomainSpec
    Domain specification.
    Statuses List<Pulumiverse.Cpln.Inputs.DomainStatus>
    Tags Dictionary<string, string>
    Key-value map of resource tags.
    CplnId string
    The ID, in GUID format, of the Domain.
    Description string
    Description of the domain name.
    Name string
    Domain name. (e.g., example.com / test.example.com). Control Plane will validate the existence of the domain with DNS. Create and Update will fail if the required DNS entries cannot be validated.
    SelfLink string
    Full link to this resource. Can be referenced by other resources.
    Spec DomainSpecArgs
    Domain specification.
    Statuses []DomainStatusArgs
    Tags map[string]string
    Key-value map of resource tags.
    cplnId String
    The ID, in GUID format, of the Domain.
    description String
    Description of the domain name.
    name String
    Domain name. (e.g., example.com / test.example.com). Control Plane will validate the existence of the domain with DNS. Create and Update will fail if the required DNS entries cannot be validated.
    selfLink String
    Full link to this resource. Can be referenced by other resources.
    spec DomainSpec
    Domain specification.
    statuses List<DomainStatus>
    tags Map<String,String>
    Key-value map of resource tags.
    cplnId string
    The ID, in GUID format, of the Domain.
    description string
    Description of the domain name.
    name string
    Domain name. (e.g., example.com / test.example.com). Control Plane will validate the existence of the domain with DNS. Create and Update will fail if the required DNS entries cannot be validated.
    selfLink string
    Full link to this resource. Can be referenced by other resources.
    spec DomainSpec
    Domain specification.
    statuses DomainStatus[]
    tags {[key: string]: string}
    Key-value map of resource tags.
    cpln_id str
    The ID, in GUID format, of the Domain.
    description str
    Description of the domain name.
    name str
    Domain name. (e.g., example.com / test.example.com). Control Plane will validate the existence of the domain with DNS. Create and Update will fail if the required DNS entries cannot be validated.
    self_link str
    Full link to this resource. Can be referenced by other resources.
    spec DomainSpecArgs
    Domain specification.
    statuses Sequence[DomainStatusArgs]
    tags Mapping[str, str]
    Key-value map of resource tags.
    cplnId String
    The ID, in GUID format, of the Domain.
    description String
    Description of the domain name.
    name String
    Domain name. (e.g., example.com / test.example.com). Control Plane will validate the existence of the domain with DNS. Create and Update will fail if the required DNS entries cannot be validated.
    selfLink String
    Full link to this resource. Can be referenced by other resources.
    spec Property Map
    Domain specification.
    statuses List<Property Map>
    tags Map<String>
    Key-value map of resource tags.

    Supporting Types

    DomainSpec, DomainSpecArgs

    DomainSpecPort, DomainSpecPortArgs

    DomainSpecPortCors, DomainSpecPortCorsArgs

    DomainSpecPortCorsAllowOrigin, DomainSpecPortCorsAllowOriginArgs

    Exact string
    Exact string
    exact String
    exact string
    exact str
    exact String

    DomainSpecPortTls, DomainSpecPortTlsArgs

    DomainSpecPortTlsClientCertificate, DomainSpecPortTlsClientCertificateArgs

    SecretLink string
    SecretLink string
    secretLink String
    secretLink string
    secretLink String

    DomainSpecPortTlsServerCertificate, DomainSpecPortTlsServerCertificateArgs

    SecretLink string
    SecretLink string
    secretLink String
    secretLink string
    secretLink String

    DomainStatus, DomainStatusArgs

    DomainStatusDnsConfig, DomainStatusDnsConfigArgs

    Host string
    Ttl int
    Type string
    Value string
    Host string
    Ttl int
    Type string
    Value string
    host String
    ttl Integer
    type String
    value String
    host string
    ttl number
    type string
    value string
    host str
    ttl int
    type str
    value str
    host String
    ttl Number
    type String
    value String

    DomainStatusEndpoint, DomainStatusEndpointArgs

    Url string
    WorkloadLink string
    Url string
    WorkloadLink string
    url String
    workloadLink String
    url string
    workloadLink string
    url String
    workloadLink String

    DomainStatusLocation, DomainStatusLocationArgs

    CertificateStatus string
    Name string
    CertificateStatus string
    Name string
    certificateStatus String
    name String
    certificateStatus string
    name string
    certificateStatus String
    name String

    Package Details

    Repository
    cpln pulumiverse/pulumi-cpln
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cpln Terraform Provider.
    cpln logo
    Control Plane v0.0.47 published on Saturday, Nov 9, 2024 by pulumiverse
    pulumiverse/pulumi-cpln