@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DescribeDomainResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Constructor and Description |
---|
DescribeDomainResult() |
Modifier and Type | Method and Description |
---|---|
DescribeDomainResult |
clone() |
boolean |
equals(Object obj) |
String |
getAppNetworkAccessType()
Specifies the VPC used for non-EFS traffic.
|
String |
getAppSecurityGroupManagement()
The entity that creates and manages the required security groups for inter-app communication in
VPCOnly mode. |
String |
getAuthMode()
The domain's authentication mode.
|
Date |
getCreationTime()
The creation time.
|
DefaultSpaceSettings |
getDefaultSpaceSettings()
The default settings used to create a space.
|
UserSettings |
getDefaultUserSettings()
Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given
UserProfile.
|
String |
getDomainArn()
The domain's Amazon Resource Name (ARN).
|
String |
getDomainId()
The domain ID.
|
String |
getDomainName()
The domain name.
|
DomainSettings |
getDomainSettings()
A collection of
Domain settings. |
String |
getFailureReason()
The failure reason.
|
String |
getHomeEfsFileSystemId()
The ID of the Amazon Elastic File System managed by this Domain.
|
String |
getHomeEfsFileSystemKmsKeyId()
Deprecated.
|
String |
getKmsKeyId()
The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.
|
Date |
getLastModifiedTime()
The last modified time.
|
String |
getSecurityGroupIdForDomainBoundary()
The ID of the security group that authorizes traffic between the
RSessionGateway apps and the
RStudioServerPro app. |
String |
getSingleSignOnApplicationArn()
The ARN of the application managed by SageMaker in IAM Identity Center.
|
String |
getSingleSignOnManagedApplicationInstanceId()
The IAM Identity Center managed application instance ID.
|
String |
getStatus()
The status.
|
List<String> |
getSubnetIds()
The VPC subnets that the domain uses for communication.
|
String |
getUrl()
The domain's URL.
|
String |
getVpcId()
The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
|
int |
hashCode() |
void |
setAppNetworkAccessType(String appNetworkAccessType)
Specifies the VPC used for non-EFS traffic.
|
void |
setAppSecurityGroupManagement(String appSecurityGroupManagement)
The entity that creates and manages the required security groups for inter-app communication in
VPCOnly mode. |
void |
setAuthMode(String authMode)
The domain's authentication mode.
|
void |
setCreationTime(Date creationTime)
The creation time.
|
void |
setDefaultSpaceSettings(DefaultSpaceSettings defaultSpaceSettings)
The default settings used to create a space.
|
void |
setDefaultUserSettings(UserSettings defaultUserSettings)
Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given
UserProfile.
|
void |
setDomainArn(String domainArn)
The domain's Amazon Resource Name (ARN).
|
void |
setDomainId(String domainId)
The domain ID.
|
void |
setDomainName(String domainName)
The domain name.
|
void |
setDomainSettings(DomainSettings domainSettings)
A collection of
Domain settings. |
void |
setFailureReason(String failureReason)
The failure reason.
|
void |
setHomeEfsFileSystemId(String homeEfsFileSystemId)
The ID of the Amazon Elastic File System managed by this Domain.
|
void |
setHomeEfsFileSystemKmsKeyId(String homeEfsFileSystemKmsKeyId)
Deprecated.
|
void |
setKmsKeyId(String kmsKeyId)
The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.
|
void |
setLastModifiedTime(Date lastModifiedTime)
The last modified time.
|
void |
setSecurityGroupIdForDomainBoundary(String securityGroupIdForDomainBoundary)
The ID of the security group that authorizes traffic between the
RSessionGateway apps and the
RStudioServerPro app. |
void |
setSingleSignOnApplicationArn(String singleSignOnApplicationArn)
The ARN of the application managed by SageMaker in IAM Identity Center.
|
void |
setSingleSignOnManagedApplicationInstanceId(String singleSignOnManagedApplicationInstanceId)
The IAM Identity Center managed application instance ID.
|
void |
setStatus(String status)
The status.
|
void |
setSubnetIds(Collection<String> subnetIds)
The VPC subnets that the domain uses for communication.
|
void |
setUrl(String url)
The domain's URL.
|
void |
setVpcId(String vpcId)
The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
|
String |
toString()
Returns a string representation of this object.
|
DescribeDomainResult |
withAppNetworkAccessType(AppNetworkAccessType appNetworkAccessType)
Specifies the VPC used for non-EFS traffic.
|
DescribeDomainResult |
withAppNetworkAccessType(String appNetworkAccessType)
Specifies the VPC used for non-EFS traffic.
|
DescribeDomainResult |
withAppSecurityGroupManagement(AppSecurityGroupManagement appSecurityGroupManagement)
The entity that creates and manages the required security groups for inter-app communication in
VPCOnly mode. |
DescribeDomainResult |
withAppSecurityGroupManagement(String appSecurityGroupManagement)
The entity that creates and manages the required security groups for inter-app communication in
VPCOnly mode. |
DescribeDomainResult |
withAuthMode(AuthMode authMode)
The domain's authentication mode.
|
DescribeDomainResult |
withAuthMode(String authMode)
The domain's authentication mode.
|
DescribeDomainResult |
withCreationTime(Date creationTime)
The creation time.
|
DescribeDomainResult |
withDefaultSpaceSettings(DefaultSpaceSettings defaultSpaceSettings)
The default settings used to create a space.
|
DescribeDomainResult |
withDefaultUserSettings(UserSettings defaultUserSettings)
Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given
UserProfile.
|
DescribeDomainResult |
withDomainArn(String domainArn)
The domain's Amazon Resource Name (ARN).
|
DescribeDomainResult |
withDomainId(String domainId)
The domain ID.
|
DescribeDomainResult |
withDomainName(String domainName)
The domain name.
|
DescribeDomainResult |
withDomainSettings(DomainSettings domainSettings)
A collection of
Domain settings. |
DescribeDomainResult |
withFailureReason(String failureReason)
The failure reason.
|
DescribeDomainResult |
withHomeEfsFileSystemId(String homeEfsFileSystemId)
The ID of the Amazon Elastic File System managed by this Domain.
|
DescribeDomainResult |
withHomeEfsFileSystemKmsKeyId(String homeEfsFileSystemKmsKeyId)
Deprecated.
|
DescribeDomainResult |
withKmsKeyId(String kmsKeyId)
The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.
|
DescribeDomainResult |
withLastModifiedTime(Date lastModifiedTime)
The last modified time.
|
DescribeDomainResult |
withSecurityGroupIdForDomainBoundary(String securityGroupIdForDomainBoundary)
The ID of the security group that authorizes traffic between the
RSessionGateway apps and the
RStudioServerPro app. |
DescribeDomainResult |
withSingleSignOnApplicationArn(String singleSignOnApplicationArn)
The ARN of the application managed by SageMaker in IAM Identity Center.
|
DescribeDomainResult |
withSingleSignOnManagedApplicationInstanceId(String singleSignOnManagedApplicationInstanceId)
The IAM Identity Center managed application instance ID.
|
DescribeDomainResult |
withStatus(DomainStatus status)
The status.
|
DescribeDomainResult |
withStatus(String status)
The status.
|
DescribeDomainResult |
withSubnetIds(Collection<String> subnetIds)
The VPC subnets that the domain uses for communication.
|
DescribeDomainResult |
withSubnetIds(String... subnetIds)
The VPC subnets that the domain uses for communication.
|
DescribeDomainResult |
withUrl(String url)
The domain's URL.
|
DescribeDomainResult |
withVpcId(String vpcId)
The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setDomainArn(String domainArn)
The domain's Amazon Resource Name (ARN).
domainArn
- The domain's Amazon Resource Name (ARN).public String getDomainArn()
The domain's Amazon Resource Name (ARN).
public DescribeDomainResult withDomainArn(String domainArn)
The domain's Amazon Resource Name (ARN).
domainArn
- The domain's Amazon Resource Name (ARN).public void setDomainId(String domainId)
The domain ID.
domainId
- The domain ID.public String getDomainId()
The domain ID.
public DescribeDomainResult withDomainId(String domainId)
The domain ID.
domainId
- The domain ID.public void setDomainName(String domainName)
The domain name.
domainName
- The domain name.public String getDomainName()
The domain name.
public DescribeDomainResult withDomainName(String domainName)
The domain name.
domainName
- The domain name.public void setHomeEfsFileSystemId(String homeEfsFileSystemId)
The ID of the Amazon Elastic File System managed by this Domain.
homeEfsFileSystemId
- The ID of the Amazon Elastic File System managed by this Domain.public String getHomeEfsFileSystemId()
The ID of the Amazon Elastic File System managed by this Domain.
public DescribeDomainResult withHomeEfsFileSystemId(String homeEfsFileSystemId)
The ID of the Amazon Elastic File System managed by this Domain.
homeEfsFileSystemId
- The ID of the Amazon Elastic File System managed by this Domain.public void setSingleSignOnManagedApplicationInstanceId(String singleSignOnManagedApplicationInstanceId)
The IAM Identity Center managed application instance ID.
singleSignOnManagedApplicationInstanceId
- The IAM Identity Center managed application instance ID.public String getSingleSignOnManagedApplicationInstanceId()
The IAM Identity Center managed application instance ID.
public DescribeDomainResult withSingleSignOnManagedApplicationInstanceId(String singleSignOnManagedApplicationInstanceId)
The IAM Identity Center managed application instance ID.
singleSignOnManagedApplicationInstanceId
- The IAM Identity Center managed application instance ID.public void setSingleSignOnApplicationArn(String singleSignOnApplicationArn)
The ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for domains created after October 1, 2023.
singleSignOnApplicationArn
- The ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for
domains created after October 1, 2023.public String getSingleSignOnApplicationArn()
The ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for domains created after October 1, 2023.
public DescribeDomainResult withSingleSignOnApplicationArn(String singleSignOnApplicationArn)
The ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for domains created after October 1, 2023.
singleSignOnApplicationArn
- The ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for
domains created after October 1, 2023.public void setStatus(String status)
The status.
status
- The status.DomainStatus
public String getStatus()
The status.
DomainStatus
public DescribeDomainResult withStatus(String status)
The status.
status
- The status.DomainStatus
public DescribeDomainResult withStatus(DomainStatus status)
The status.
status
- The status.DomainStatus
public void setCreationTime(Date creationTime)
The creation time.
creationTime
- The creation time.public Date getCreationTime()
The creation time.
public DescribeDomainResult withCreationTime(Date creationTime)
The creation time.
creationTime
- The creation time.public void setLastModifiedTime(Date lastModifiedTime)
The last modified time.
lastModifiedTime
- The last modified time.public Date getLastModifiedTime()
The last modified time.
public DescribeDomainResult withLastModifiedTime(Date lastModifiedTime)
The last modified time.
lastModifiedTime
- The last modified time.public void setFailureReason(String failureReason)
The failure reason.
failureReason
- The failure reason.public String getFailureReason()
The failure reason.
public DescribeDomainResult withFailureReason(String failureReason)
The failure reason.
failureReason
- The failure reason.public void setSecurityGroupIdForDomainBoundary(String securityGroupIdForDomainBoundary)
The ID of the security group that authorizes traffic between the RSessionGateway
apps and the
RStudioServerPro
app.
securityGroupIdForDomainBoundary
- The ID of the security group that authorizes traffic between the RSessionGateway
apps and the
RStudioServerPro
app.public String getSecurityGroupIdForDomainBoundary()
The ID of the security group that authorizes traffic between the RSessionGateway
apps and the
RStudioServerPro
app.
RSessionGateway
apps and
the RStudioServerPro
app.public DescribeDomainResult withSecurityGroupIdForDomainBoundary(String securityGroupIdForDomainBoundary)
The ID of the security group that authorizes traffic between the RSessionGateway
apps and the
RStudioServerPro
app.
securityGroupIdForDomainBoundary
- The ID of the security group that authorizes traffic between the RSessionGateway
apps and the
RStudioServerPro
app.public void setAuthMode(String authMode)
The domain's authentication mode.
authMode
- The domain's authentication mode.AuthMode
public String getAuthMode()
The domain's authentication mode.
AuthMode
public DescribeDomainResult withAuthMode(String authMode)
The domain's authentication mode.
authMode
- The domain's authentication mode.AuthMode
public DescribeDomainResult withAuthMode(AuthMode authMode)
The domain's authentication mode.
authMode
- The domain's authentication mode.AuthMode
public void setDefaultUserSettings(UserSettings defaultUserSettings)
Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.
defaultUserSettings
- Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a
given UserProfile.public UserSettings getDefaultUserSettings()
Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.
public DescribeDomainResult withDefaultUserSettings(UserSettings defaultUserSettings)
Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.
defaultUserSettings
- Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a
given UserProfile.public void setDomainSettings(DomainSettings domainSettings)
A collection of Domain
settings.
domainSettings
- A collection of Domain
settings.public DomainSettings getDomainSettings()
A collection of Domain
settings.
Domain
settings.public DescribeDomainResult withDomainSettings(DomainSettings domainSettings)
A collection of Domain
settings.
domainSettings
- A collection of Domain
settings.public void setAppNetworkAccessType(String appNetworkAccessType)
Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly
.
PublicInternetOnly
- Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows
direct internet access
VpcOnly
- All traffic is through the specified VPC and subnets
appNetworkAccessType
- Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly
.
PublicInternetOnly
- Non-EFS traffic is through a VPC managed by Amazon SageMaker, which
allows direct internet access
VpcOnly
- All traffic is through the specified VPC and subnets
AppNetworkAccessType
public String getAppNetworkAccessType()
Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly
.
PublicInternetOnly
- Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows
direct internet access
VpcOnly
- All traffic is through the specified VPC and subnets
PublicInternetOnly
.
PublicInternetOnly
- Non-EFS traffic is through a VPC managed by Amazon SageMaker, which
allows direct internet access
VpcOnly
- All traffic is through the specified VPC and subnets
AppNetworkAccessType
public DescribeDomainResult withAppNetworkAccessType(String appNetworkAccessType)
Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly
.
PublicInternetOnly
- Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows
direct internet access
VpcOnly
- All traffic is through the specified VPC and subnets
appNetworkAccessType
- Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly
.
PublicInternetOnly
- Non-EFS traffic is through a VPC managed by Amazon SageMaker, which
allows direct internet access
VpcOnly
- All traffic is through the specified VPC and subnets
AppNetworkAccessType
public DescribeDomainResult withAppNetworkAccessType(AppNetworkAccessType appNetworkAccessType)
Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly
.
PublicInternetOnly
- Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows
direct internet access
VpcOnly
- All traffic is through the specified VPC and subnets
appNetworkAccessType
- Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly
.
PublicInternetOnly
- Non-EFS traffic is through a VPC managed by Amazon SageMaker, which
allows direct internet access
VpcOnly
- All traffic is through the specified VPC and subnets
AppNetworkAccessType
@Deprecated public void setHomeEfsFileSystemKmsKeyId(String homeEfsFileSystemKmsKeyId)
Use KmsKeyId
.
homeEfsFileSystemKmsKeyId
- Use KmsKeyId
.@Deprecated public String getHomeEfsFileSystemKmsKeyId()
Use KmsKeyId
.
KmsKeyId
.@Deprecated public DescribeDomainResult withHomeEfsFileSystemKmsKeyId(String homeEfsFileSystemKmsKeyId)
Use KmsKeyId
.
homeEfsFileSystemKmsKeyId
- Use KmsKeyId
.public List<String> getSubnetIds()
The VPC subnets that the domain uses for communication.
public void setSubnetIds(Collection<String> subnetIds)
The VPC subnets that the domain uses for communication.
subnetIds
- The VPC subnets that the domain uses for communication.public DescribeDomainResult withSubnetIds(String... subnetIds)
The VPC subnets that the domain uses for communication.
NOTE: This method appends the values to the existing list (if any). Use
setSubnetIds(java.util.Collection)
or withSubnetIds(java.util.Collection)
if you want to
override the existing values.
subnetIds
- The VPC subnets that the domain uses for communication.public DescribeDomainResult withSubnetIds(Collection<String> subnetIds)
The VPC subnets that the domain uses for communication.
subnetIds
- The VPC subnets that the domain uses for communication.public void setUrl(String url)
The domain's URL.
url
- The domain's URL.public String getUrl()
The domain's URL.
public DescribeDomainResult withUrl(String url)
The domain's URL.
url
- The domain's URL.public void setVpcId(String vpcId)
The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
vpcId
- The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.public String getVpcId()
The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
public DescribeDomainResult withVpcId(String vpcId)
The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
vpcId
- The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.public void setKmsKeyId(String kmsKeyId)
The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.
kmsKeyId
- The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.public String getKmsKeyId()
The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.
public DescribeDomainResult withKmsKeyId(String kmsKeyId)
The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.
kmsKeyId
- The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.public void setAppSecurityGroupManagement(String appSecurityGroupManagement)
The entity that creates and manages the required security groups for inter-app communication in
VPCOnly
mode. Required when CreateDomain.AppNetworkAccessType
is VPCOnly
and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn
is provided.
appSecurityGroupManagement
- The entity that creates and manages the required security groups for inter-app communication in
VPCOnly
mode. Required when CreateDomain.AppNetworkAccessType
is
VPCOnly
and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn
is provided.AppSecurityGroupManagement
public String getAppSecurityGroupManagement()
The entity that creates and manages the required security groups for inter-app communication in
VPCOnly
mode. Required when CreateDomain.AppNetworkAccessType
is VPCOnly
and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn
is provided.
VPCOnly
mode. Required when CreateDomain.AppNetworkAccessType
is
VPCOnly
and
DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn
is provided.AppSecurityGroupManagement
public DescribeDomainResult withAppSecurityGroupManagement(String appSecurityGroupManagement)
The entity that creates and manages the required security groups for inter-app communication in
VPCOnly
mode. Required when CreateDomain.AppNetworkAccessType
is VPCOnly
and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn
is provided.
appSecurityGroupManagement
- The entity that creates and manages the required security groups for inter-app communication in
VPCOnly
mode. Required when CreateDomain.AppNetworkAccessType
is
VPCOnly
and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn
is provided.AppSecurityGroupManagement
public DescribeDomainResult withAppSecurityGroupManagement(AppSecurityGroupManagement appSecurityGroupManagement)
The entity that creates and manages the required security groups for inter-app communication in
VPCOnly
mode. Required when CreateDomain.AppNetworkAccessType
is VPCOnly
and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn
is provided.
appSecurityGroupManagement
- The entity that creates and manages the required security groups for inter-app communication in
VPCOnly
mode. Required when CreateDomain.AppNetworkAccessType
is
VPCOnly
and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn
is provided.AppSecurityGroupManagement
public void setDefaultSpaceSettings(DefaultSpaceSettings defaultSpaceSettings)
The default settings used to create a space.
defaultSpaceSettings
- The default settings used to create a space.public DefaultSpaceSettings getDefaultSpaceSettings()
The default settings used to create a space.
public DescribeDomainResult withDefaultSpaceSettings(DefaultSpaceSettings defaultSpaceSettings)
The default settings used to create a space.
defaultSpaceSettings
- The default settings used to create a space.public String toString()
toString
in class Object
Object.toString()
public DescribeDomainResult clone()