1. Packages
  2. AWS Native
  3. API Docs
  4. datazone
  5. Domain

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

aws-native.datazone.Domain

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

    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,
               kms_key_identifier: Optional[str] = None,
               name: 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

    The Domain resource accepts the following input properties:

    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.
    Description string
    The description of the Amazon DataZone domain.
    KmsKeyIdentifier string
    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.
    SingleSignOn Pulumi.AwsNative.DataZone.Inputs.DomainSingleSignOn
    The single-sign on configuration of the Amazon DataZone domain.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The tags specified for 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.
    Description string
    The description of the Amazon DataZone domain.
    KmsKeyIdentifier string
    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.
    SingleSignOn DomainSingleSignOnArgs
    The single-sign on configuration of the Amazon DataZone domain.
    Tags TagArgs
    The tags specified for 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.
    description String
    The description of the Amazon DataZone domain.
    kmsKeyIdentifier String
    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.
    singleSignOn DomainSingleSignOn
    The single-sign on configuration of the Amazon DataZone domain.
    tags List<Tag>
    The tags specified for 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.
    description string
    The description of the Amazon DataZone domain.
    kmsKeyIdentifier string
    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.
    singleSignOn DomainSingleSignOn
    The single-sign on configuration of the Amazon DataZone domain.
    tags Tag[]
    The tags specified for 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.
    description str
    The description of the Amazon DataZone domain.
    kms_key_identifier str
    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.
    single_sign_on DomainSingleSignOnArgs
    The single-sign on configuration of the Amazon DataZone domain.
    tags Sequence[TagArgs]
    The tags specified for 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.
    description String
    The description of the Amazon DataZone domain.
    kmsKeyIdentifier String
    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.
    singleSignOn Property Map
    The single-sign on configuration of the Amazon DataZone domain.
    tags 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.
    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.
    PortalUrl string
    The URL of the data portal for this Amazon DataZone domain.
    Status Pulumi.AwsNative.DataZone.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.
    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.
    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.
    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.
    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.
    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.
    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_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.
    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.
    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.
    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
    DomainAuthTypeIamIdc
    IAM_IDC
    DomainAuthTypeDisabled
    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.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, DomainStatusArgs

    Creating
    CREATING
    Available
    AVAILABLE
    CreationFailed
    CREATION_FAILED
    Deleting
    DELETING
    Deleted
    DELETED
    DeletionFailed
    DELETION_FAILED
    DomainStatusCreating
    CREATING
    DomainStatusAvailable
    AVAILABLE
    DomainStatusCreationFailed
    CREATION_FAILED
    DomainStatusDeleting
    DELETING
    DomainStatusDeleted
    DELETED
    DomainStatusDeletionFailed
    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
    DomainUserAssignmentAutomatic
    AUTOMATIC
    DomainUserAssignmentManual
    MANUAL
    Automatic
    AUTOMATIC
    Manual
    MANUAL
    Automatic
    AUTOMATIC
    Manual
    MANUAL
    AUTOMATIC
    AUTOMATIC
    MANUAL
    MANUAL
    "AUTOMATIC"
    AUTOMATIC
    "MANUAL"
    MANUAL

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi