1. Packages
  2. Athenz Provider
  3. API Docs
  4. TopLevelDomain
athenz 1.0.45 published on Tuesday, Apr 15, 2025 by athenz

athenz.TopLevelDomain

Explore with Pulumi AI

Example Usage

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

const athenzTopLevelDomain_test = new athenz.TopLevelDomain("athenzTopLevelDomain-test", {
    adminUsers: ["user.someone"],
    auditRef: "create domain",
    ypmId: "some_positive_integer",
});
Copy
import pulumi
import pulumi_athenz as athenz

athenz_top_level_domain_test = athenz.TopLevelDomain("athenzTopLevelDomain-test",
    admin_users=["user.someone"],
    audit_ref="create domain",
    ypm_id="some_positive_integer")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := athenz.NewTopLevelDomain(ctx, "athenzTopLevelDomain-test", &athenz.TopLevelDomainArgs{
			AdminUsers: pulumi.StringArray{
				pulumi.String("user.someone"),
			},
			AuditRef: pulumi.String("create domain"),
			YpmId:    pulumi.Float64("some_positive_integer"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Athenz = Pulumi.Athenz;

return await Deployment.RunAsync(() => 
{
    var athenzTopLevelDomain_test = new Athenz.TopLevelDomain("athenzTopLevelDomain-test", new()
    {
        AdminUsers = new[]
        {
            "user.someone",
        },
        AuditRef = "create domain",
        YpmId = "some_positive_integer",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.athenz.TopLevelDomain;
import com.pulumi.athenz.TopLevelDomainArgs;
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 athenzTopLevelDomain_test = new TopLevelDomain("athenzTopLevelDomain-test", TopLevelDomainArgs.builder()
            .adminUsers("user.someone")
            .auditRef("create domain")
            .ypmId("some_positive_integer")
            .build());

    }
}
Copy
resources:
  athenzTopLevelDomain-test:
    type: athenz:TopLevelDomain
    properties:
      adminUsers:
        - user.someone
      auditRef: create domain
      ypmId: some_positive_integer
Copy

Create TopLevelDomain Resource

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

Constructor syntax

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

@overload
def TopLevelDomain(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   admin_users: Optional[Sequence[str]] = None,
                   ypm_id: Optional[float] = None,
                   audit_ref: Optional[str] = None,
                   name: Optional[str] = None,
                   top_level_domain_id: Optional[str] = None)
func NewTopLevelDomain(ctx *Context, name string, args TopLevelDomainArgs, opts ...ResourceOption) (*TopLevelDomain, error)
public TopLevelDomain(string name, TopLevelDomainArgs args, CustomResourceOptions? opts = null)
public TopLevelDomain(String name, TopLevelDomainArgs args)
public TopLevelDomain(String name, TopLevelDomainArgs args, CustomResourceOptions options)
type: athenz:TopLevelDomain
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. TopLevelDomainArgs
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. TopLevelDomainArgs
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. TopLevelDomainArgs
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. TopLevelDomainArgs
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. TopLevelDomainArgs
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 topLevelDomainResource = new Athenz.TopLevelDomain("topLevelDomainResource", new()
{
    AdminUsers = new[]
    {
        "string",
    },
    YpmId = 0,
    AuditRef = "string",
    Name = "string",
    TopLevelDomainId = "string",
});
Copy
example, err := athenz.NewTopLevelDomain(ctx, "topLevelDomainResource", &athenz.TopLevelDomainArgs{
	AdminUsers: pulumi.StringArray{
		pulumi.String("string"),
	},
	YpmId:            pulumi.Float64(0),
	AuditRef:         pulumi.String("string"),
	Name:             pulumi.String("string"),
	TopLevelDomainId: pulumi.String("string"),
})
Copy
var topLevelDomainResource = new TopLevelDomain("topLevelDomainResource", TopLevelDomainArgs.builder()
    .adminUsers("string")
    .ypmId(0)
    .auditRef("string")
    .name("string")
    .topLevelDomainId("string")
    .build());
Copy
top_level_domain_resource = athenz.TopLevelDomain("topLevelDomainResource",
    admin_users=["string"],
    ypm_id=0,
    audit_ref="string",
    name="string",
    top_level_domain_id="string")
Copy
const topLevelDomainResource = new athenz.TopLevelDomain("topLevelDomainResource", {
    adminUsers: ["string"],
    ypmId: 0,
    auditRef: "string",
    name: "string",
    topLevelDomainId: "string",
});
Copy
type: athenz:TopLevelDomain
properties:
    adminUsers:
        - string
    auditRef: string
    name: string
    topLevelDomainId: string
    ypmId: 0
Copy

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

AdminUsers This property is required. List<string>
list of domain administrators. must be in this format: user.<userid> or <domain>.<service>.
YpmId This property is required. double
  • associated product id. must be a positive integer.
AuditRef string
string containing audit specification or ticket number.
Name string
name of the domain.
TopLevelDomainId string
The ID of this resource.
AdminUsers This property is required. []string
list of domain administrators. must be in this format: user.<userid> or <domain>.<service>.
YpmId This property is required. float64
  • associated product id. must be a positive integer.
AuditRef string
string containing audit specification or ticket number.
Name string
name of the domain.
TopLevelDomainId string
The ID of this resource.
adminUsers This property is required. List<String>
list of domain administrators. must be in this format: user.<userid> or <domain>.<service>.
ypmId This property is required. Double
  • associated product id. must be a positive integer.
auditRef String
string containing audit specification or ticket number.
name String
name of the domain.
topLevelDomainId String
The ID of this resource.
adminUsers This property is required. string[]
list of domain administrators. must be in this format: user.<userid> or <domain>.<service>.
ypmId This property is required. number
  • associated product id. must be a positive integer.
auditRef string
string containing audit specification or ticket number.
name string
name of the domain.
topLevelDomainId string
The ID of this resource.
admin_users This property is required. Sequence[str]
list of domain administrators. must be in this format: user.<userid> or <domain>.<service>.
ypm_id This property is required. float
  • associated product id. must be a positive integer.
audit_ref str
string containing audit specification or ticket number.
name str
name of the domain.
top_level_domain_id str
The ID of this resource.
adminUsers This property is required. List<String>
list of domain administrators. must be in this format: user.<userid> or <domain>.<service>.
ypmId This property is required. Number
  • associated product id. must be a positive integer.
auditRef String
string containing audit specification or ticket number.
name String
name of the domain.
topLevelDomainId String
The ID of this resource.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing TopLevelDomain Resource

Get an existing TopLevelDomain 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?: TopLevelDomainState, opts?: CustomResourceOptions): TopLevelDomain
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_users: Optional[Sequence[str]] = None,
        audit_ref: Optional[str] = None,
        name: Optional[str] = None,
        top_level_domain_id: Optional[str] = None,
        ypm_id: Optional[float] = None) -> TopLevelDomain
func GetTopLevelDomain(ctx *Context, name string, id IDInput, state *TopLevelDomainState, opts ...ResourceOption) (*TopLevelDomain, error)
public static TopLevelDomain Get(string name, Input<string> id, TopLevelDomainState? state, CustomResourceOptions? opts = null)
public static TopLevelDomain get(String name, Output<String> id, TopLevelDomainState state, CustomResourceOptions options)
resources:  _:    type: athenz:TopLevelDomain    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:
AdminUsers List<string>
list of domain administrators. must be in this format: user.<userid> or <domain>.<service>.
AuditRef string
string containing audit specification or ticket number.
Name string
name of the domain.
TopLevelDomainId string
The ID of this resource.
YpmId double
  • associated product id. must be a positive integer.
AdminUsers []string
list of domain administrators. must be in this format: user.<userid> or <domain>.<service>.
AuditRef string
string containing audit specification or ticket number.
Name string
name of the domain.
TopLevelDomainId string
The ID of this resource.
YpmId float64
  • associated product id. must be a positive integer.
adminUsers List<String>
list of domain administrators. must be in this format: user.<userid> or <domain>.<service>.
auditRef String
string containing audit specification or ticket number.
name String
name of the domain.
topLevelDomainId String
The ID of this resource.
ypmId Double
  • associated product id. must be a positive integer.
adminUsers string[]
list of domain administrators. must be in this format: user.<userid> or <domain>.<service>.
auditRef string
string containing audit specification or ticket number.
name string
name of the domain.
topLevelDomainId string
The ID of this resource.
ypmId number
  • associated product id. must be a positive integer.
admin_users Sequence[str]
list of domain administrators. must be in this format: user.<userid> or <domain>.<service>.
audit_ref str
string containing audit specification or ticket number.
name str
name of the domain.
top_level_domain_id str
The ID of this resource.
ypm_id float
  • associated product id. must be a positive integer.
adminUsers List<String>
list of domain administrators. must be in this format: user.<userid> or <domain>.<service>.
auditRef String
string containing audit specification or ticket number.
name String
name of the domain.
topLevelDomainId String
The ID of this resource.
ypmId Number
  • associated product id. must be a positive integer.

Package Details

Repository
athenz athenz/terraform-provider-athenz
License
Notes
This Pulumi package is based on the athenz Terraform Provider.