athenz 1.0.45, Apr 15 25

athenz 1.0.45 published on Tuesday, Apr 15, 2025 by athenz

athenz.SubDomain

Explore with Pulumi AI

athenz 1.0.45 published on Tuesday, Apr 15, 2025 by athenz

Example Usage

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

const subDomain_test = new athenz.SubDomain("subDomain-test", {
    adminUsers: ["user.someone"],
    auditRef: "create domain",
    parentName: "home.some_user",
});

import pulumi
import pulumi_athenz as athenz

sub_domain_test = athenz.SubDomain("subDomain-test",
    admin_users=["user.someone"],
    audit_ref="create domain",
    parent_name="home.some_user")

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.NewSubDomain(ctx, "subDomain-test", &athenz.SubDomainArgs{
			AdminUsers: pulumi.StringArray{
				pulumi.String("user.someone"),
			},
			AuditRef:   pulumi.String("create domain"),
			ParentName: pulumi.String("home.some_user"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Athenz = Pulumi.Athenz;

return await Deployment.RunAsync(() => 
{
    var subDomain_test = new Athenz.SubDomain("subDomain-test", new()
    {
        AdminUsers = new[]
        {
            "user.someone",
        },
        AuditRef = "create domain",
        ParentName = "home.some_user",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.athenz.SubDomain;
import com.pulumi.athenz.SubDomainArgs;
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 subDomain_test = new SubDomain("subDomain-test", SubDomainArgs.builder()
            .adminUsers("user.someone")
            .auditRef("create domain")
            .parentName("home.some_user")
            .build());

    }
}

resources:
  subDomain-test:
    type: athenz:SubDomain
    properties:
      adminUsers:
        - user.someone
      auditRef: create domain
      parentName: home.some_user

Create SubDomain Resource

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

Constructor syntax

new SubDomain(name: string, args: SubDomainArgs, opts?: CustomResourceOptions);

@overload
def SubDomain(resource_name: str,
              args: SubDomainArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def SubDomain(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              admin_users: Optional[Sequence[str]] = None,
              parent_name: Optional[str] = None,
              audit_ref: Optional[str] = None,
              name: Optional[str] = None,
              sub_domain_id: Optional[str] = None)

func NewSubDomain(ctx *Context, name string, args SubDomainArgs, opts ...ResourceOption) (*SubDomain, error)

public SubDomain(string name, SubDomainArgs args, CustomResourceOptions? opts = null)

public SubDomain(String name, SubDomainArgs args)
public SubDomain(String name, SubDomainArgs args, CustomResourceOptions options)

type: athenz:SubDomain
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 SubDomainArgs: 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 SubDomainArgs: 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 SubDomainArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SubDomainArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SubDomainArgs: 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 subDomainResource = new Athenz.SubDomain("subDomainResource", new()
{
    AdminUsers = new[]
    {
        "string",
    },
    ParentName = "string",
    AuditRef = "string",
    Name = "string",
    SubDomainId = "string",
});

example, err := athenz.NewSubDomain(ctx, "subDomainResource", &athenz.SubDomainArgs{
	AdminUsers: pulumi.StringArray{
		pulumi.String("string"),
	},
	ParentName:  pulumi.String("string"),
	AuditRef:    pulumi.String("string"),
	Name:        pulumi.String("string"),
	SubDomainId: pulumi.String("string"),
})

var subDomainResource = new SubDomain("subDomainResource", SubDomainArgs.builder()
    .adminUsers("string")
    .parentName("string")
    .auditRef("string")
    .name("string")
    .subDomainId("string")
    .build());

sub_domain_resource = athenz.SubDomain("subDomainResource",
    admin_users=["string"],
    parent_name="string",
    audit_ref="string",
    name="string",
    sub_domain_id="string")

const subDomainResource = new athenz.SubDomain("subDomainResource", {
    adminUsers: ["string"],
    parentName: "string",
    auditRef: "string",
    name: "string",
    subDomainId: "string",
});

type: athenz:SubDomain
properties:
    adminUsers:
        - string
    auditRef: string
    name: string
    parentName: string
    subDomainId: string

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

AdminUsers List<string>: list of domain administrators. must be in this format: user.<userid> or <domain>.<service>.
ParentName string: name of the parent domain.
AuditRef string: string containing audit specification or ticket number.
Name string: name of the parent domain.
SubDomainId string: The ID of this resource.

AdminUsers []string: list of domain administrators. must be in this format: user.<userid> or <domain>.<service>.
ParentName string: name of the parent domain.
AuditRef string: string containing audit specification or ticket number.
Name string: name of the parent domain.
SubDomainId string: The ID of this resource.

adminUsers List<String>: list of domain administrators. must be in this format: user.<userid> or <domain>.<service>.
parentName String: name of the parent domain.
auditRef String: string containing audit specification or ticket number.
name String: name of the parent domain.
subDomainId String: The ID of this resource.

adminUsers string[]: list of domain administrators. must be in this format: user.<userid> or <domain>.<service>.
parentName string: name of the parent domain.
auditRef string: string containing audit specification or ticket number.
name string: name of the parent domain.
subDomainId string: The ID of this resource.

admin_users Sequence[str]: list of domain administrators. must be in this format: user.<userid> or <domain>.<service>.
parent_name str: name of the parent domain.
audit_ref str: string containing audit specification or ticket number.
name str: name of the parent domain.
sub_domain_id str: The ID of this resource.

adminUsers List<String>: list of domain administrators. must be in this format: user.<userid> or <domain>.<service>.
parentName String: name of the parent domain.
auditRef String: string containing audit specification or ticket number.
name String: name of the parent domain.
subDomainId String: The ID of this resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the SubDomain 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 SubDomain Resource

Get an existing SubDomain 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?: SubDomainState, opts?: CustomResourceOptions): SubDomain

@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,
        parent_name: Optional[str] = None,
        sub_domain_id: Optional[str] = None) -> SubDomain

func GetSubDomain(ctx *Context, name string, id IDInput, state *SubDomainState, opts ...ResourceOption) (*SubDomain, error)

public static SubDomain Get(string name, Input<string> id, SubDomainState? state, CustomResourceOptions? opts = null)

public static SubDomain get(String name, Output<String> id, SubDomainState state, CustomResourceOptions options)

resources:  _:    type: athenz:SubDomain    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:

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 parent domain.
ParentName string: name of the parent domain.
SubDomainId string: The ID of this resource.

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 parent domain.
ParentName string: name of the parent domain.
SubDomainId string: The ID of this resource.

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 parent domain.
parentName String: name of the parent domain.
subDomainId String: The ID of this resource.

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 parent domain.
parentName string: name of the parent domain.
subDomainId string: The ID of this resource.

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 parent domain.
parent_name str: name of the parent domain.
sub_domain_id str: The ID of this resource.

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 parent domain.
parentName String: name of the parent domain.
subDomainId String: The ID of this resource.

Package Details

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

athenz 1.0.45 published on Tuesday, Apr 15, 2025 by athenz

athenz/terraform-provider-athenz

athenz.SubDomain

On this page

On this page

Example Usage

Create SubDomain Resource

Constructor syntax

Parameters

Constructor example

SubDomain Resource Properties

Inputs

Outputs

Look up Existing SubDomain Resource

Package Details

On this page

On this page