/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the sagemaker-2017-07-24.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.SageMaker.Model
{
///
/// This is the response object from the DescribeDomain operation.
///
public partial class DescribeDomainResponse : AmazonWebServiceResponse
{
private AppNetworkAccessType _appNetworkAccessType;
private AppSecurityGroupManagement _appSecurityGroupManagement;
private AuthMode _authMode;
private DateTime? _creationTime;
private DefaultSpaceSettings _defaultSpaceSettings;
private UserSettings _defaultUserSettings;
private string _domainArn;
private string _domainId;
private string _domainName;
private DomainSettings _domainSettings;
private string _failureReason;
private string _homeEfsFileSystemId;
private string _homeEfsFileSystemKmsKeyId;
private string _kmsKeyId;
private DateTime? _lastModifiedTime;
private string _securityGroupIdForDomainBoundary;
private string _singleSignOnManagedApplicationInstanceId;
private DomainStatus _status;
private List _subnetIds = new List();
private string _url;
private string _vpcId;
///
/// Gets and sets the property 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 Studio traffic is through the specified VPC and subnets
///
///
///
public AppNetworkAccessType AppNetworkAccessType
{
get { return this._appNetworkAccessType; }
set { this._appNetworkAccessType = value; }
}
// Check to see if AppNetworkAccessType property is set
internal bool IsSetAppNetworkAccessType()
{
return this._appNetworkAccessType != null;
}
///
/// Gets and sets the property 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.
///
///
public AppSecurityGroupManagement AppSecurityGroupManagement
{
get { return this._appSecurityGroupManagement; }
set { this._appSecurityGroupManagement = value; }
}
// Check to see if AppSecurityGroupManagement property is set
internal bool IsSetAppSecurityGroupManagement()
{
return this._appSecurityGroupManagement != null;
}
///
/// Gets and sets the property AuthMode.
///
/// The domain's authentication mode.
///
///
public AuthMode AuthMode
{
get { return this._authMode; }
set { this._authMode = value; }
}
// Check to see if AuthMode property is set
internal bool IsSetAuthMode()
{
return this._authMode != null;
}
///
/// Gets and sets the property CreationTime.
///
/// The creation time.
///
///
public DateTime CreationTime
{
get { return this._creationTime.GetValueOrDefault(); }
set { this._creationTime = value; }
}
// Check to see if CreationTime property is set
internal bool IsSetCreationTime()
{
return this._creationTime.HasValue;
}
///
/// Gets and sets the property DefaultSpaceSettings.
///
/// The default settings used to create a space.
///
///
public DefaultSpaceSettings DefaultSpaceSettings
{
get { return this._defaultSpaceSettings; }
set { this._defaultSpaceSettings = value; }
}
// Check to see if DefaultSpaceSettings property is set
internal bool IsSetDefaultSpaceSettings()
{
return this._defaultSpaceSettings != null;
}
///
/// Gets and sets the property DefaultUserSettings.
///
/// Settings which are applied to UserProfiles in this domain if settings are not explicitly
/// specified in a given UserProfile.
///
///
public UserSettings DefaultUserSettings
{
get { return this._defaultUserSettings; }
set { this._defaultUserSettings = value; }
}
// Check to see if DefaultUserSettings property is set
internal bool IsSetDefaultUserSettings()
{
return this._defaultUserSettings != null;
}
///
/// Gets and sets the property DomainArn.
///
/// The domain's Amazon Resource Name (ARN).
///
///
[AWSProperty(Max=256)]
public string DomainArn
{
get { return this._domainArn; }
set { this._domainArn = value; }
}
// Check to see if DomainArn property is set
internal bool IsSetDomainArn()
{
return this._domainArn != null;
}
///
/// Gets and sets the property DomainId.
///
/// The domain ID.
///
///
[AWSProperty(Max=63)]
public string DomainId
{
get { return this._domainId; }
set { this._domainId = value; }
}
// Check to see if DomainId property is set
internal bool IsSetDomainId()
{
return this._domainId != null;
}
///
/// Gets and sets the property DomainName.
///
/// The domain name.
///
///
[AWSProperty(Max=63)]
public string DomainName
{
get { return this._domainName; }
set { this._domainName = value; }
}
// Check to see if DomainName property is set
internal bool IsSetDomainName()
{
return this._domainName != null;
}
///
/// Gets and sets the property DomainSettings.
///
/// A collection of Domain
settings.
///
///
public DomainSettings DomainSettings
{
get { return this._domainSettings; }
set { this._domainSettings = value; }
}
// Check to see if DomainSettings property is set
internal bool IsSetDomainSettings()
{
return this._domainSettings != null;
}
///
/// Gets and sets the property FailureReason.
///
/// The failure reason.
///
///
[AWSProperty(Max=1024)]
public string FailureReason
{
get { return this._failureReason; }
set { this._failureReason = value; }
}
// Check to see if FailureReason property is set
internal bool IsSetFailureReason()
{
return this._failureReason != null;
}
///
/// Gets and sets the property HomeEfsFileSystemId.
///
/// The ID of the Amazon Elastic File System (EFS) managed by this Domain.
///
///
[AWSProperty(Max=32)]
public string HomeEfsFileSystemId
{
get { return this._homeEfsFileSystemId; }
set { this._homeEfsFileSystemId = value; }
}
// Check to see if HomeEfsFileSystemId property is set
internal bool IsSetHomeEfsFileSystemId()
{
return this._homeEfsFileSystemId != null;
}
///
/// Gets and sets the property HomeEfsFileSystemKmsKeyId.
///
/// Use KmsKeyId
.
///
///
[Obsolete("This property is deprecated, use KmsKeyId instead.")]
[AWSProperty(Max=2048)]
public string HomeEfsFileSystemKmsKeyId
{
get { return this._homeEfsFileSystemKmsKeyId; }
set { this._homeEfsFileSystemKmsKeyId = value; }
}
// Check to see if HomeEfsFileSystemKmsKeyId property is set
internal bool IsSetHomeEfsFileSystemKmsKeyId()
{
return this._homeEfsFileSystemKmsKeyId != null;
}
///
/// Gets and sets the property KmsKeyId.
///
/// The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached
/// to the domain.
///
///
[AWSProperty(Max=2048)]
public string KmsKeyId
{
get { return this._kmsKeyId; }
set { this._kmsKeyId = value; }
}
// Check to see if KmsKeyId property is set
internal bool IsSetKmsKeyId()
{
return this._kmsKeyId != null;
}
///
/// Gets and sets the property LastModifiedTime.
///
/// The last modified time.
///
///
public DateTime LastModifiedTime
{
get { return this._lastModifiedTime.GetValueOrDefault(); }
set { this._lastModifiedTime = value; }
}
// Check to see if LastModifiedTime property is set
internal bool IsSetLastModifiedTime()
{
return this._lastModifiedTime.HasValue;
}
///
/// Gets and sets the property SecurityGroupIdForDomainBoundary.
///
/// The ID of the security group that authorizes traffic between the RSessionGateway
/// apps and the RStudioServerPro
app.
///
///
[AWSProperty(Max=32)]
public string SecurityGroupIdForDomainBoundary
{
get { return this._securityGroupIdForDomainBoundary; }
set { this._securityGroupIdForDomainBoundary = value; }
}
// Check to see if SecurityGroupIdForDomainBoundary property is set
internal bool IsSetSecurityGroupIdForDomainBoundary()
{
return this._securityGroupIdForDomainBoundary != null;
}
///
/// Gets and sets the property SingleSignOnManagedApplicationInstanceId.
///
/// The IAM Identity Center managed application instance ID.
///
///
[AWSProperty(Max=256)]
public string SingleSignOnManagedApplicationInstanceId
{
get { return this._singleSignOnManagedApplicationInstanceId; }
set { this._singleSignOnManagedApplicationInstanceId = value; }
}
// Check to see if SingleSignOnManagedApplicationInstanceId property is set
internal bool IsSetSingleSignOnManagedApplicationInstanceId()
{
return this._singleSignOnManagedApplicationInstanceId != null;
}
///
/// Gets and sets the property Status.
///
/// The status.
///
///
public DomainStatus Status
{
get { return this._status; }
set { this._status = value; }
}
// Check to see if Status property is set
internal bool IsSetStatus()
{
return this._status != null;
}
///
/// Gets and sets the property SubnetIds.
///
/// The VPC subnets that Studio uses for communication.
///
///
[AWSProperty(Min=1, Max=16)]
public List SubnetIds
{
get { return this._subnetIds; }
set { this._subnetIds = value; }
}
// Check to see if SubnetIds property is set
internal bool IsSetSubnetIds()
{
return this._subnetIds != null && this._subnetIds.Count > 0;
}
///
/// Gets and sets the property Url.
///
/// The domain's URL.
///
///
[AWSProperty(Max=1024)]
public string Url
{
get { return this._url; }
set { this._url = value; }
}
// Check to see if Url property is set
internal bool IsSetUrl()
{
return this._url != null;
}
///
/// Gets and sets the property VpcId.
///
/// The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
///
///
[AWSProperty(Max=32)]
public string VpcId
{
get { return this._vpcId; }
set { this._vpcId = value; }
}
// Check to see if VpcId property is set
internal bool IsSetVpcId()
{
return this._vpcId != null;
}
}
}