DomainState class

Input properties used for looking up and filtering Domain resources.

Constructors

DomainState({Input<String?>? appNetworkAccessType, Input<String?>? appSecurityGroupManagement, Input<String?>? arn, Input<String?>? authMode, Input<DomainDefaultSpaceSettings?>? defaultSpaceSettings, Input<DomainDefaultUserSettings?>? defaultUserSettings, Input<String?>? domainName, Input<DomainDomainSettings?>? domainSettings, Input<String?>? homeEfsFileSystemId, Input<String?>? kmsKeyId, Input<String?>? region, Input<DomainRetentionPolicy?>? retentionPolicy, Input<String?>? securityGroupIdForDomainBoundary, Input<String?>? singleSignOnApplicationArn, Input<String?>? singleSignOnManagedApplicationInstanceId, Input<List<String>?>? subnetIds, Input<String?>? tagPropagation, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<String?>? url, Input<String?>? vpcId})
Creates a new DomainState. appNetworkAccessType Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly. Valid values are PublicInternetOnly and VpcOnly. appSecurityGroupManagement The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Valid values are Service and Customer. arn ARN assigned by AWS to this Domain. authMode The mode of authentication that members use to access the domain. Valid values are IAM and SSO. defaultSpaceSettings The default space settings. See defaultSpaceSettings Block below. defaultUserSettings The default user settings. See defaultUserSettings Block below. domainName The domain name. domainSettings The domain settings. See domainSettings Block below. homeEfsFileSystemId The ID of the Amazon Elastic File System (EFS) managed by this Domain. kmsKeyId The AWS KMS customer managed CMK used to encrypt the EFS volume attached to the domain. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. retentionPolicy The retention policy for this domain, which specifies whether resources will be retained after the Domain is deleted. By default, all resources are retained. See retentionPolicy Block below. securityGroupIdForDomainBoundary The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app. singleSignOnApplicationArn The ARN of the application managed by SageMaker AI in IAM Identity Center. This value is only returned for domains created after September 19, 2023. singleSignOnManagedApplicationInstanceId The SSO managed application instance ID. subnetIds The VPC subnets that Studio uses for communication. tagPropagation Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED. Valid values are: ENABLED and DISABLED. tags A map of tags to assign to the resource. .If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. url The domain's URL. vpcId ID of the VPC that Studio uses for communication.
const
DomainState.fromMap(Map<String, dynamic> map)
factory

Properties

appNetworkAccessType → Input<String?>?
Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly. Valid values are PublicInternetOnly and VpcOnly.
final
appSecurityGroupManagement → Input<String?>?
The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Valid values are Service and Customer.
final
arn → Input<String?>?
ARN assigned by AWS to this Domain.
final
authMode → Input<String?>?
The mode of authentication that members use to access the domain. Valid values are IAM and SSO.
final
defaultSpaceSettings → Input<DomainDefaultSpaceSettings?>?
The default space settings. See defaultSpaceSettings Block below.
final
defaultUserSettings → Input<DomainDefaultUserSettings?>?
The default user settings. See defaultUserSettings Block below.
final
domainName → Input<String?>?
The domain name.
final
domainSettings → Input<DomainDomainSettings?>?
The domain settings. See domainSettings Block below.
final
hashCode → int
The hash code for this object.
no setterinherited
homeEfsFileSystemId → Input<String?>?
The ID of the Amazon Elastic File System (EFS) managed by this Domain.
final
kmsKeyId → Input<String?>?
The AWS KMS customer managed CMK used to encrypt the EFS volume attached to the domain.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
retentionPolicy → Input<DomainRetentionPolicy?>?
The retention policy for this domain, which specifies whether resources will be retained after the Domain is deleted. By default, all resources are retained. See retentionPolicy Block below.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityGroupIdForDomainBoundary → Input<String?>?
The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.
final
singleSignOnApplicationArn → Input<String?>?
The ARN of the application managed by SageMaker AI in IAM Identity Center. This value is only returned for domains created after September 19, 2023.
final
singleSignOnManagedApplicationInstanceId → Input<String?>?
The SSO managed application instance ID.
final
subnetIds → Input<List<String>?>?
The VPC subnets that Studio uses for communication.
final
tagPropagation → Input<String?>?
Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED. Valid values are: ENABLED and DISABLED.
final
tags → Input<Map<String, String>?>?
A map of tags to assign to the resource. .If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
url → Input<String?>?
The domain's URL.
final
vpcId → Input<String?>?
ID of the VPC that Studio uses for communication.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited