Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
The description of the domain.
Synopsis
- data DescribeDomain = DescribeDomain' {}
- newDescribeDomain :: Text -> DescribeDomain
- describeDomain_domainId :: Lens' DescribeDomain Text
- data DescribeDomainResponse = DescribeDomainResponse' {
- appNetworkAccessType :: Maybe AppNetworkAccessType
- appSecurityGroupManagement :: Maybe AppSecurityGroupManagement
- authMode :: Maybe AuthMode
- creationTime :: Maybe POSIX
- defaultSpaceSettings :: Maybe DefaultSpaceSettings
- defaultUserSettings :: Maybe UserSettings
- domainArn :: Maybe Text
- domainId :: Maybe Text
- domainName :: Maybe Text
- domainSettings :: Maybe DomainSettings
- failureReason :: Maybe Text
- homeEfsFileSystemId :: Maybe Text
- homeEfsFileSystemKmsKeyId :: Maybe Text
- kmsKeyId :: Maybe Text
- lastModifiedTime :: Maybe POSIX
- securityGroupIdForDomainBoundary :: Maybe Text
- singleSignOnManagedApplicationInstanceId :: Maybe Text
- status :: Maybe DomainStatus
- subnetIds :: Maybe (NonEmpty Text)
- url :: Maybe Text
- vpcId :: Maybe Text
- httpStatus :: Int
- newDescribeDomainResponse :: Int -> DescribeDomainResponse
- describeDomainResponse_appNetworkAccessType :: Lens' DescribeDomainResponse (Maybe AppNetworkAccessType)
- describeDomainResponse_appSecurityGroupManagement :: Lens' DescribeDomainResponse (Maybe AppSecurityGroupManagement)
- describeDomainResponse_authMode :: Lens' DescribeDomainResponse (Maybe AuthMode)
- describeDomainResponse_creationTime :: Lens' DescribeDomainResponse (Maybe UTCTime)
- describeDomainResponse_defaultSpaceSettings :: Lens' DescribeDomainResponse (Maybe DefaultSpaceSettings)
- describeDomainResponse_defaultUserSettings :: Lens' DescribeDomainResponse (Maybe UserSettings)
- describeDomainResponse_domainArn :: Lens' DescribeDomainResponse (Maybe Text)
- describeDomainResponse_domainId :: Lens' DescribeDomainResponse (Maybe Text)
- describeDomainResponse_domainName :: Lens' DescribeDomainResponse (Maybe Text)
- describeDomainResponse_domainSettings :: Lens' DescribeDomainResponse (Maybe DomainSettings)
- describeDomainResponse_failureReason :: Lens' DescribeDomainResponse (Maybe Text)
- describeDomainResponse_homeEfsFileSystemId :: Lens' DescribeDomainResponse (Maybe Text)
- describeDomainResponse_homeEfsFileSystemKmsKeyId :: Lens' DescribeDomainResponse (Maybe Text)
- describeDomainResponse_kmsKeyId :: Lens' DescribeDomainResponse (Maybe Text)
- describeDomainResponse_lastModifiedTime :: Lens' DescribeDomainResponse (Maybe UTCTime)
- describeDomainResponse_securityGroupIdForDomainBoundary :: Lens' DescribeDomainResponse (Maybe Text)
- describeDomainResponse_singleSignOnManagedApplicationInstanceId :: Lens' DescribeDomainResponse (Maybe Text)
- describeDomainResponse_status :: Lens' DescribeDomainResponse (Maybe DomainStatus)
- describeDomainResponse_subnetIds :: Lens' DescribeDomainResponse (Maybe (NonEmpty Text))
- describeDomainResponse_url :: Lens' DescribeDomainResponse (Maybe Text)
- describeDomainResponse_vpcId :: Lens' DescribeDomainResponse (Maybe Text)
- describeDomainResponse_httpStatus :: Lens' DescribeDomainResponse Int
Creating a Request
data DescribeDomain Source #
See: newDescribeDomain
smart constructor.
Instances
Create a value of DescribeDomain
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeDomain
, describeDomain_domainId
- The domain ID.
Request Lenses
describeDomain_domainId :: Lens' DescribeDomain Text Source #
The domain ID.
Destructuring the Response
data DescribeDomainResponse Source #
See: newDescribeDomainResponse
smart constructor.
DescribeDomainResponse' | |
|
Instances
newDescribeDomainResponse Source #
Create a value of DescribeDomainResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appNetworkAccessType:DescribeDomainResponse'
, describeDomainResponse_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 accessVpcOnly
- All Studio traffic is through the specified VPC and subnets
$sel:appSecurityGroupManagement:DescribeDomainResponse'
, describeDomainResponse_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.
$sel:authMode:DescribeDomainResponse'
, describeDomainResponse_authMode
- The domain's authentication mode.
DescribeDomainResponse
, describeDomainResponse_creationTime
- The creation time.
$sel:defaultSpaceSettings:DescribeDomainResponse'
, describeDomainResponse_defaultSpaceSettings
- The default settings used to create a space.
$sel:defaultUserSettings:DescribeDomainResponse'
, describeDomainResponse_defaultUserSettings
- Settings which are applied to UserProfiles in this domain if settings
are not explicitly specified in a given UserProfile.
DescribeDomainResponse
, describeDomainResponse_domainArn
- The domain's Amazon Resource Name (ARN).
DescribeDomain
, describeDomainResponse_domainId
- The domain ID.
DescribeDomainResponse
, describeDomainResponse_domainName
- The domain name.
$sel:domainSettings:DescribeDomainResponse'
, describeDomainResponse_domainSettings
- A collection of Domain
settings.
DescribeDomainResponse
, describeDomainResponse_failureReason
- The failure reason.
$sel:homeEfsFileSystemId:DescribeDomainResponse'
, describeDomainResponse_homeEfsFileSystemId
- The ID of the Amazon Elastic File System (EFS) managed by this Domain.
$sel:homeEfsFileSystemKmsKeyId:DescribeDomainResponse'
, describeDomainResponse_homeEfsFileSystemKmsKeyId
- Use KmsKeyId
.
DescribeDomainResponse
, describeDomainResponse_kmsKeyId
- The Amazon Web Services KMS customer managed key used to encrypt the EFS
volume attached to the domain.
DescribeDomainResponse
, describeDomainResponse_lastModifiedTime
- The last modified time.
$sel:securityGroupIdForDomainBoundary:DescribeDomainResponse'
, describeDomainResponse_securityGroupIdForDomainBoundary
- The ID of the security group that authorizes traffic between the
RSessionGateway
apps and the RStudioServerPro
app.
$sel:singleSignOnManagedApplicationInstanceId:DescribeDomainResponse'
, describeDomainResponse_singleSignOnManagedApplicationInstanceId
- The IAM Identity Center managed application instance ID.
DescribeDomainResponse
, describeDomainResponse_status
- The status.
$sel:subnetIds:DescribeDomainResponse'
, describeDomainResponse_subnetIds
- The VPC subnets that Studio uses for communication.
DescribeDomainResponse
, describeDomainResponse_url
- The domain's URL.
DescribeDomainResponse
, describeDomainResponse_vpcId
- The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for
communication.
$sel:httpStatus:DescribeDomainResponse'
, describeDomainResponse_httpStatus
- The response's http status code.
Response Lenses
describeDomainResponse_appNetworkAccessType :: Lens' DescribeDomainResponse (Maybe AppNetworkAccessType) Source #
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 accessVpcOnly
- All Studio traffic is through the specified VPC and subnets
describeDomainResponse_appSecurityGroupManagement :: Lens' DescribeDomainResponse (Maybe AppSecurityGroupManagement) Source #
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.
describeDomainResponse_authMode :: Lens' DescribeDomainResponse (Maybe AuthMode) Source #
The domain's authentication mode.
describeDomainResponse_creationTime :: Lens' DescribeDomainResponse (Maybe UTCTime) Source #
The creation time.
describeDomainResponse_defaultSpaceSettings :: Lens' DescribeDomainResponse (Maybe DefaultSpaceSettings) Source #
The default settings used to create a space.
describeDomainResponse_defaultUserSettings :: Lens' DescribeDomainResponse (Maybe UserSettings) Source #
Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.
describeDomainResponse_domainArn :: Lens' DescribeDomainResponse (Maybe Text) Source #
The domain's Amazon Resource Name (ARN).
describeDomainResponse_domainId :: Lens' DescribeDomainResponse (Maybe Text) Source #
The domain ID.
describeDomainResponse_domainName :: Lens' DescribeDomainResponse (Maybe Text) Source #
The domain name.
describeDomainResponse_domainSettings :: Lens' DescribeDomainResponse (Maybe DomainSettings) Source #
A collection of Domain
settings.
describeDomainResponse_failureReason :: Lens' DescribeDomainResponse (Maybe Text) Source #
The failure reason.
describeDomainResponse_homeEfsFileSystemId :: Lens' DescribeDomainResponse (Maybe Text) Source #
The ID of the Amazon Elastic File System (EFS) managed by this Domain.
describeDomainResponse_homeEfsFileSystemKmsKeyId :: Lens' DescribeDomainResponse (Maybe Text) Source #
Use KmsKeyId
.
describeDomainResponse_kmsKeyId :: Lens' DescribeDomainResponse (Maybe Text) Source #
The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.
describeDomainResponse_lastModifiedTime :: Lens' DescribeDomainResponse (Maybe UTCTime) Source #
The last modified time.
describeDomainResponse_securityGroupIdForDomainBoundary :: Lens' DescribeDomainResponse (Maybe Text) Source #
The ID of the security group that authorizes traffic between the
RSessionGateway
apps and the RStudioServerPro
app.
describeDomainResponse_singleSignOnManagedApplicationInstanceId :: Lens' DescribeDomainResponse (Maybe Text) Source #
The IAM Identity Center managed application instance ID.
describeDomainResponse_status :: Lens' DescribeDomainResponse (Maybe DomainStatus) Source #
The status.
describeDomainResponse_subnetIds :: Lens' DescribeDomainResponse (Maybe (NonEmpty Text)) Source #
The VPC subnets that Studio uses for communication.
describeDomainResponse_url :: Lens' DescribeDomainResponse (Maybe Text) Source #
The domain's URL.
describeDomainResponse_vpcId :: Lens' DescribeDomainResponse (Maybe Text) Source #
The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
describeDomainResponse_httpStatus :: Lens' DescribeDomainResponse Int Source #
The response's http status code.