Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. datazone
  5. getDomain

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.datazone.getDomain

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

A domain is an organizing entity for connecting together assets, users, and their projects

Using getDomain

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDomain(args: GetDomainArgs, opts?: InvokeOptions): Promise<GetDomainResult>
function getDomainOutput(args: GetDomainOutputArgs, opts?: InvokeOptions): Output<GetDomainResult>
Copy
def get_domain(id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetDomainResult
def get_domain_output(id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetDomainResult]
Copy
func LookupDomain(ctx *Context, args *LookupDomainArgs, opts ...InvokeOption) (*LookupDomainResult, error)
func LookupDomainOutput(ctx *Context, args *LookupDomainOutputArgs, opts ...InvokeOption) LookupDomainResultOutput
Copy

> Note: This function is named LookupDomain in the Go SDK.

public static class GetDomain 
{
    public static Task<GetDomainResult> InvokeAsync(GetDomainArgs args, InvokeOptions? opts = null)
    public static Output<GetDomainResult> Invoke(GetDomainInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDomainResult> getDomain(GetDomainArgs args, InvokeOptions options)
public static Output<GetDomainResult> getDomain(GetDomainArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:datazone:getDomain
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. string
The id of the Amazon DataZone domain.
Id This property is required. string
The id of the Amazon DataZone domain.
id This property is required. String
The id of the Amazon DataZone domain.
id This property is required. string
The id of the Amazon DataZone domain.
id This property is required. str
The id of the Amazon DataZone domain.
id This property is required. String
The id of the Amazon DataZone domain.

getDomain Result

The following output properties are available:

Arn string
The ARN of the Amazon DataZone domain.
CreatedAt string
The timestamp of when the Amazon DataZone domain was last updated.
Description string
The description of the Amazon DataZone domain.
DomainExecutionRole string
The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the AWS account that houses the Amazon DataZone domain.
Id string
The id of the Amazon DataZone domain.
LastUpdatedAt string
The timestamp of when the Amazon DataZone domain was last updated.
ManagedAccountId string
The identifier of the AWS account that manages the domain.
Name string
The name of the Amazon DataZone domain.
PortalUrl string
The URL of the data portal for this Amazon DataZone domain.
ServiceRole string
The service role of the domain that is created.
SingleSignOn Pulumi.AwsNative.DataZone.Outputs.DomainSingleSignOn
The single-sign on configuration of the Amazon DataZone domain.
Status Pulumi.AwsNative.DataZone.DomainStatus
The status of the Amazon DataZone domain.
Tags List<Pulumi.AwsNative.Outputs.Tag>
The tags specified for the Amazon DataZone domain.
Arn string
The ARN of the Amazon DataZone domain.
CreatedAt string
The timestamp of when the Amazon DataZone domain was last updated.
Description string
The description of the Amazon DataZone domain.
DomainExecutionRole string
The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the AWS account that houses the Amazon DataZone domain.
Id string
The id of the Amazon DataZone domain.
LastUpdatedAt string
The timestamp of when the Amazon DataZone domain was last updated.
ManagedAccountId string
The identifier of the AWS account that manages the domain.
Name string
The name of the Amazon DataZone domain.
PortalUrl string
The URL of the data portal for this Amazon DataZone domain.
ServiceRole string
The service role of the domain that is created.
SingleSignOn DomainSingleSignOn
The single-sign on configuration of the Amazon DataZone domain.
Status DomainStatus
The status of the Amazon DataZone domain.
Tags Tag
The tags specified for the Amazon DataZone domain.
arn String
The ARN of the Amazon DataZone domain.
createdAt String
The timestamp of when the Amazon DataZone domain was last updated.
description String
The description of the Amazon DataZone domain.
domainExecutionRole String
The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the AWS account that houses the Amazon DataZone domain.
id String
The id of the Amazon DataZone domain.
lastUpdatedAt String
The timestamp of when the Amazon DataZone domain was last updated.
managedAccountId String
The identifier of the AWS account that manages the domain.
name String
The name of the Amazon DataZone domain.
portalUrl String
The URL of the data portal for this Amazon DataZone domain.
serviceRole String
The service role of the domain that is created.
singleSignOn DomainSingleSignOn
The single-sign on configuration of the Amazon DataZone domain.
status DomainStatus
The status of the Amazon DataZone domain.
tags List<Tag>
The tags specified for the Amazon DataZone domain.
arn string
The ARN of the Amazon DataZone domain.
createdAt string
The timestamp of when the Amazon DataZone domain was last updated.
description string
The description of the Amazon DataZone domain.
domainExecutionRole string
The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the AWS account that houses the Amazon DataZone domain.
id string
The id of the Amazon DataZone domain.
lastUpdatedAt string
The timestamp of when the Amazon DataZone domain was last updated.
managedAccountId string
The identifier of the AWS account that manages the domain.
name string
The name of the Amazon DataZone domain.
portalUrl string
The URL of the data portal for this Amazon DataZone domain.
serviceRole string
The service role of the domain that is created.
singleSignOn DomainSingleSignOn
The single-sign on configuration of the Amazon DataZone domain.
status DomainStatus
The status of the Amazon DataZone domain.
tags Tag[]
The tags specified for the Amazon DataZone domain.
arn str
The ARN of the Amazon DataZone domain.
created_at str
The timestamp of when the Amazon DataZone domain was last updated.
description str
The description of the Amazon DataZone domain.
domain_execution_role str
The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the AWS account that houses the Amazon DataZone domain.
id str
The id of the Amazon DataZone domain.
last_updated_at str
The timestamp of when the Amazon DataZone domain was last updated.
managed_account_id str
The identifier of the AWS account that manages the domain.
name str
The name of the Amazon DataZone domain.
portal_url str
The URL of the data portal for this Amazon DataZone domain.
service_role str
The service role of the domain that is created.
single_sign_on DomainSingleSignOn
The single-sign on configuration of the Amazon DataZone domain.
status DomainStatus
The status of the Amazon DataZone domain.
tags Sequence[root_Tag]
The tags specified for the Amazon DataZone domain.
arn String
The ARN of the Amazon DataZone domain.
createdAt String
The timestamp of when the Amazon DataZone domain was last updated.
description String
The description of the Amazon DataZone domain.
domainExecutionRole String
The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the AWS account that houses the Amazon DataZone domain.
id String
The id of the Amazon DataZone domain.
lastUpdatedAt String
The timestamp of when the Amazon DataZone domain was last updated.
managedAccountId String
The identifier of the AWS account that manages the domain.
name String
The name of the Amazon DataZone domain.
portalUrl String
The URL of the data portal for this Amazon DataZone domain.
serviceRole String
The service role of the domain that is created.
singleSignOn Property Map
The single-sign on configuration of the Amazon DataZone domain.
status "CREATING" | "AVAILABLE" | "CREATION_FAILED" | "DELETING" | "DELETED" | "DELETION_FAILED"
The status of the Amazon DataZone domain.
tags List<Property Map>
The tags specified for the Amazon DataZone domain.

Supporting Types

DomainAuthType

DomainSingleSignOn

Type Pulumi.AwsNative.DataZone.DomainAuthType
The type of single sign-on in Amazon DataZone.
UserAssignment Pulumi.AwsNative.DataZone.DomainUserAssignment
The single sign-on user assignment in Amazon DataZone.
Type DomainAuthType
The type of single sign-on in Amazon DataZone.
UserAssignment DomainUserAssignment
The single sign-on user assignment in Amazon DataZone.
type DomainAuthType
The type of single sign-on in Amazon DataZone.
userAssignment DomainUserAssignment
The single sign-on user assignment in Amazon DataZone.
type DomainAuthType
The type of single sign-on in Amazon DataZone.
userAssignment DomainUserAssignment
The single sign-on user assignment in Amazon DataZone.
type DomainAuthType
The type of single sign-on in Amazon DataZone.
user_assignment DomainUserAssignment
The single sign-on user assignment in Amazon DataZone.
type "IAM_IDC" | "DISABLED"
The type of single sign-on in Amazon DataZone.
userAssignment "AUTOMATIC" | "MANUAL"
The single sign-on user assignment in Amazon DataZone.

DomainStatus

DomainUserAssignment

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native