We recommend new projects start with resources from the AWS provider.
aws-native.datazone.Domain
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
A domain is an organizing entity for connecting together assets, users, and their projects
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,
           domain_execution_role: Optional[str] = None,
           description: Optional[str] = None,
           domain_version: Optional[DomainVersion] = None,
           kms_key_identifier: Optional[str] = None,
           name: Optional[str] = None,
           service_role: Optional[str] = None,
           single_sign_on: Optional[DomainSingleSignOnArgs] = None,
           tags: Optional[Sequence[_root_inputs.TagArgs]] = 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: aws-native:datazone: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.
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:
- DomainExecution stringRole 
- 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.
- Description string
- The description of the Amazon DataZone domain.
- DomainVersion Pulumi.Aws Native. Data Zone. Domain Version 
- The version of the domain.
- KmsKey stringIdentifier 
- The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.
- Name string
- The name of the Amazon DataZone domain.
- ServiceRole string
- The service role of the domain that is created.
- SingleSign Pulumi.On Aws Native. Data Zone. Inputs. Domain Single Sign On 
- The single-sign on configuration of the Amazon DataZone domain.
- 
List<Pulumi.Aws Native. Inputs. Tag> 
- The tags specified for the Amazon DataZone domain.
- DomainExecution stringRole 
- 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.
- Description string
- The description of the Amazon DataZone domain.
- DomainVersion DomainVersion 
- The version of the domain.
- KmsKey stringIdentifier 
- The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.
- Name string
- The name of the Amazon DataZone domain.
- ServiceRole string
- The service role of the domain that is created.
- SingleSign DomainOn Single Sign On Args 
- The single-sign on configuration of the Amazon DataZone domain.
- 
TagArgs 
- The tags specified for the Amazon DataZone domain.
- domainExecution StringRole 
- 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.
- description String
- The description of the Amazon DataZone domain.
- domainVersion DomainVersion 
- The version of the domain.
- kmsKey StringIdentifier 
- The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.
- name String
- The name of the Amazon DataZone domain.
- serviceRole String
- The service role of the domain that is created.
- singleSign DomainOn Single Sign On 
- The single-sign on configuration of the Amazon DataZone domain.
- List<Tag>
- The tags specified for the Amazon DataZone domain.
- domainExecution stringRole 
- 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.
- description string
- The description of the Amazon DataZone domain.
- domainVersion DomainVersion 
- The version of the domain.
- kmsKey stringIdentifier 
- The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.
- name string
- The name of the Amazon DataZone domain.
- serviceRole string
- The service role of the domain that is created.
- singleSign DomainOn Single Sign On 
- The single-sign on configuration of the Amazon DataZone domain.
- Tag[]
- The tags specified for the Amazon DataZone domain.
- domain_execution_ strrole 
- 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.
- description str
- The description of the Amazon DataZone domain.
- domain_version DomainVersion 
- The version of the domain.
- kms_key_ stridentifier 
- The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.
- name str
- The name of the Amazon DataZone domain.
- service_role str
- The service role of the domain that is created.
- single_sign_ Domainon Single Sign On Args 
- The single-sign on configuration of the Amazon DataZone domain.
- 
Sequence[TagArgs] 
- The tags specified for the Amazon DataZone domain.
- domainExecution StringRole 
- 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.
- description String
- The description of the Amazon DataZone domain.
- domainVersion "V1" | "V2"
- The version of the domain.
- kmsKey StringIdentifier 
- The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.
- name String
- The name of the Amazon DataZone domain.
- serviceRole String
- The service role of the domain that is created.
- singleSign Property MapOn 
- The single-sign on configuration of the Amazon DataZone domain.
- List<Property Map>
- The tags specified for the Amazon DataZone domain.
Outputs
All input properties are implicitly available as output properties. Additionally, the Domain resource produces the following output properties:
- Arn string
- The ARN of the Amazon DataZone domain.
- AwsId string
- The id of the Amazon DataZone domain.
- CreatedAt string
- The timestamp of when the Amazon DataZone domain was last updated.
- Id string
- The provider-assigned unique ID for this managed resource.
- LastUpdated stringAt 
- The timestamp of when the Amazon DataZone domain was last updated.
- ManagedAccount stringId 
- The identifier of the AWS account that manages the domain.
- PortalUrl string
- The URL of the data portal for this Amazon DataZone domain.
- Status
Pulumi.Aws Native. Data Zone. Domain Status 
- The status of the Amazon DataZone domain.
- Arn string
- The ARN of the Amazon DataZone domain.
- AwsId string
- The id of the Amazon DataZone domain.
- CreatedAt string
- The timestamp of when the Amazon DataZone domain was last updated.
- Id string
- The provider-assigned unique ID for this managed resource.
- LastUpdated stringAt 
- The timestamp of when the Amazon DataZone domain was last updated.
- ManagedAccount stringId 
- The identifier of the AWS account that manages the domain.
- PortalUrl string
- The URL of the data portal for this Amazon DataZone domain.
- Status
DomainStatus 
- The status of the Amazon DataZone domain.
- arn String
- The ARN of the Amazon DataZone domain.
- awsId String
- The id of the Amazon DataZone domain.
- createdAt String
- The timestamp of when the Amazon DataZone domain was last updated.
- id String
- The provider-assigned unique ID for this managed resource.
- lastUpdated StringAt 
- The timestamp of when the Amazon DataZone domain was last updated.
- managedAccount StringId 
- The identifier of the AWS account that manages the domain.
- portalUrl String
- The URL of the data portal for this Amazon DataZone domain.
- status
DomainStatus 
- The status of the Amazon DataZone domain.
- arn string
- The ARN of the Amazon DataZone domain.
- awsId string
- The id of the Amazon DataZone domain.
- createdAt string
- The timestamp of when the Amazon DataZone domain was last updated.
- id string
- The provider-assigned unique ID for this managed resource.
- lastUpdated stringAt 
- The timestamp of when the Amazon DataZone domain was last updated.
- managedAccount stringId 
- The identifier of the AWS account that manages the domain.
- portalUrl string
- The URL of the data portal for this Amazon DataZone domain.
- status
DomainStatus 
- The status of the Amazon DataZone domain.
- arn str
- The ARN of the Amazon DataZone domain.
- aws_id str
- The id of the Amazon DataZone domain.
- created_at str
- The timestamp of when the Amazon DataZone domain was last updated.
- id str
- The provider-assigned unique ID for this managed resource.
- last_updated_ strat 
- The timestamp of when the Amazon DataZone domain was last updated.
- managed_account_ strid 
- The identifier of the AWS account that manages the domain.
- portal_url str
- The URL of the data portal for this Amazon DataZone domain.
- status
DomainStatus 
- The status of the Amazon DataZone domain.
- arn String
- The ARN of the Amazon DataZone domain.
- awsId String
- The id of the Amazon DataZone domain.
- createdAt String
- The timestamp of when the Amazon DataZone domain was last updated.
- id String
- The provider-assigned unique ID for this managed resource.
- lastUpdated StringAt 
- The timestamp of when the Amazon DataZone domain was last updated.
- managedAccount StringId 
- The identifier of the AWS account that manages the domain.
- portalUrl String
- The URL of the data portal for this Amazon DataZone domain.
- status "CREATING" | "AVAILABLE" | "CREATION_FAILED" | "DELETING" | "DELETED" | "DELETION_FAILED"
- The status of the Amazon DataZone domain.
Supporting Types
DomainAuthType, DomainAuthTypeArgs      
- IamIdc 
- IAM_IDC
- Disabled
- DISABLED
- DomainAuth Type Iam Idc 
- IAM_IDC
- DomainAuth Type Disabled 
- DISABLED
- IamIdc 
- IAM_IDC
- Disabled
- DISABLED
- IamIdc 
- IAM_IDC
- Disabled
- DISABLED
- IAM_IDC
- IAM_IDC
- DISABLED
- DISABLED
- "IAM_IDC"
- IAM_IDC
- "DISABLED"
- DISABLED
DomainSingleSignOn, DomainSingleSignOnArgs        
- Type
Pulumi.Aws Native. Data Zone. Domain Auth Type 
- The type of single sign-on in Amazon DataZone.
- UserAssignment Pulumi.Aws Native. Data Zone. Domain User Assignment 
- The single sign-on user assignment in Amazon DataZone.
- Type
DomainAuth Type 
- The type of single sign-on in Amazon DataZone.
- UserAssignment DomainUser Assignment 
- The single sign-on user assignment in Amazon DataZone.
- type
DomainAuth Type 
- The type of single sign-on in Amazon DataZone.
- userAssignment DomainUser Assignment 
- The single sign-on user assignment in Amazon DataZone.
- type
DomainAuth Type 
- The type of single sign-on in Amazon DataZone.
- userAssignment DomainUser Assignment 
- The single sign-on user assignment in Amazon DataZone.
- type
DomainAuth Type 
- The type of single sign-on in Amazon DataZone.
- user_assignment DomainUser Assignment 
- 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, DomainStatusArgs    
- Creating
- CREATING
- Available
- AVAILABLE
- CreationFailed 
- CREATION_FAILED
- Deleting
- DELETING
- Deleted
- DELETED
- DeletionFailed 
- DELETION_FAILED
- DomainStatus Creating 
- CREATING
- DomainStatus Available 
- AVAILABLE
- DomainStatus Creation Failed 
- CREATION_FAILED
- DomainStatus Deleting 
- DELETING
- DomainStatus Deleted 
- DELETED
- DomainStatus Deletion Failed 
- DELETION_FAILED
- Creating
- CREATING
- Available
- AVAILABLE
- CreationFailed 
- CREATION_FAILED
- Deleting
- DELETING
- Deleted
- DELETED
- DeletionFailed 
- DELETION_FAILED
- Creating
- CREATING
- Available
- AVAILABLE
- CreationFailed 
- CREATION_FAILED
- Deleting
- DELETING
- Deleted
- DELETED
- DeletionFailed 
- DELETION_FAILED
- CREATING
- CREATING
- AVAILABLE
- AVAILABLE
- CREATION_FAILED
- CREATION_FAILED
- DELETING
- DELETING
- DELETED
- DELETED
- DELETION_FAILED
- DELETION_FAILED
- "CREATING"
- CREATING
- "AVAILABLE"
- AVAILABLE
- "CREATION_FAILED"
- CREATION_FAILED
- "DELETING"
- DELETING
- "DELETED"
- DELETED
- "DELETION_FAILED"
- DELETION_FAILED
DomainUserAssignment, DomainUserAssignmentArgs      
- Automatic
- AUTOMATIC
- Manual
- MANUAL
- DomainUser Assignment Automatic 
- AUTOMATIC
- DomainUser Assignment Manual 
- MANUAL
- Automatic
- AUTOMATIC
- Manual
- MANUAL
- Automatic
- AUTOMATIC
- Manual
- MANUAL
- AUTOMATIC
- AUTOMATIC
- MANUAL
- MANUAL
- "AUTOMATIC"
- AUTOMATIC
- "MANUAL"
- MANUAL
DomainVersion, DomainVersionArgs    
- V1
- V1
- V2
- V2
- DomainVersion V1 
- V1
- DomainVersion V2 
- V2
- V1
- V1
- V2
- V2
- V1
- V1
- V2
- V2
- V1
- V1
- V2
- V2
- "V1"
- V1
- "V2"
- V2
Tag, TagArgs  
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.