Class: AWSCDK::Sagemaker::CfnDomain

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSSagemaker::IDomainRef
Defined in:
sagemaker/cfn_domain.rb

Overview

Creates a Domain .

A domain consists of an associated Amazon Elastic File System volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files and other artifacts with each other.

EFS storage

When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.

SageMaker AI uses the AWS Key Management Service ( AWS KMS) to encrypt the EFS volume attached to the domain with an AWS managed key by default. For more control, you can specify a customer managed key. For more information, see Protect Data at Rest Using Encryption .

VPC configuration

All traffic between the domain and the Amazon EFS volume is through the specified VPC and subnets. For other traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to the domain. The following options are available:

  • PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker AI, which allows internet access. This is the default value.
  • VpcOnly - All traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway.

When internet access is disabled, you won't be able to run a Amazon SageMaker AI Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker AI API and runtime or a NAT gateway and your security groups allow outbound connections.

NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a Amazon SageMaker AI Studio app successfully.

For more information, see Connect Amazon SageMaker AI Studio Notebooks to Resources in a VPC .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnDomain

Create a new AWS::SageMaker::Domain.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::Sagemaker::CfnDomainProps) —

    Resource properties.



39
40
41
42
43
44
45
 
# File 'sagemaker/cfn_domain.rb', line 39

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnDomainProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2FnZW1ha2VyLkNmbkRvbWFpblByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_domain(resource) ⇒ String

Parameters:

Returns:

  • (String) 


111
112
113
114
 
# File 'sagemaker/cfn_domain.rb', line 111

def self.arn_for_domain(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zYWdlbWFrZXIuSURvbWFpblJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_sagemaker.CfnDomain", "arnForDomain", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


244
245
246
 
# File 'sagemaker/cfn_domain.rb', line 244

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_sagemaker.CfnDomain", "CFN_RESOURCE_TYPE_NAME")
end

.from_domain_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSSagemaker::IDomainRef

Creates a new IDomainRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



122
123
124
125
126
127
 
# File 'sagemaker/cfn_domain.rb', line 122

def self.from_domain_arn(scope, id, arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_sagemaker.CfnDomain", "fromDomainArn", [scope, id, arn])
end

.from_domain_id(scope, id, domain_id) ⇒ AWSCDK::Interfaces::AWSSagemaker::IDomainRef

Creates a new IDomainRef from a domainId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • domain_id (String)

Returns:



135
136
137
138
139
140
 
# File 'sagemaker/cfn_domain.rb', line 135

def self.from_domain_id(scope, id, domain_id)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(domain_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_sagemaker.CfnDomain", "fromDomainId", [scope, id, domain_id])
end

.is_cfn_domain(x) ⇒ Boolean

Checks whether the given object is a CfnDomain.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


146
147
148
149
 
# File 'sagemaker/cfn_domain.rb', line 146

def self.is_cfn_domain(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_sagemaker.CfnDomain", "isCfnDomain", [x])
end

.jsii_overridable_methods ⇒ Object 



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'sagemaker/cfn_domain.rb', line 47

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_domain_arn => { kind: :property, name: "attrDomainArn", is_optional: false },
    :attr_domain_id => { kind: :property, name: "attrDomainId", is_optional: false },
    :attr_home_efs_file_system_id => { kind: :property, name: "attrHomeEfsFileSystemId", is_optional: false },
    :attr_security_group_id_for_domain_boundary => { kind: :property, name: "attrSecurityGroupIdForDomainBoundary", is_optional: false },
    :attr_single_sign_on_application_arn => { kind: :property, name: "attrSingleSignOnApplicationArn", is_optional: false },
    :attr_single_sign_on_managed_application_instance_id => { kind: :property, name: "attrSingleSignOnManagedApplicationInstanceId", is_optional: false },
    :attr_url => { kind: :property, name: "attrUrl", is_optional: false },
    :domain_ref => { kind: :property, name: "domainRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :auth_mode => { kind: :property, name: "authMode", is_optional: false },
    :default_user_settings => { kind: :property, name: "defaultUserSettings", is_optional: false },
    :domain_name => { kind: :property, name: "domainName", is_optional: false },
    :app_network_access_type => { kind: :property, name: "appNetworkAccessType", is_optional: true },
    :app_security_group_management => { kind: :property, name: "appSecurityGroupManagement", is_optional: true },
    :default_space_settings => { kind: :property, name: "defaultSpaceSettings", is_optional: true },
    :domain_settings => { kind: :property, name: "domainSettings", is_optional: true },
    :home_efs_file_system_creation => { kind: :property, name: "homeEfsFileSystemCreation", is_optional: true },
    :kms_key_id => { kind: :property, name: "kmsKeyId", is_optional: true },
    :subnet_ids => { kind: :property, name: "subnetIds", is_optional: true },
    :tag_propagation => { kind: :property, name: "tagPropagation", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :vpc_id => { kind: :property, name: "vpcId", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



511
512
513
514
 
# File 'sagemaker/cfn_domain.rb', line 511

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



523
524
525
526
 
# File 'sagemaker/cfn_domain.rb', line 523

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



533
534
535
536
 
# File 'sagemaker/cfn_domain.rb', line 533

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



544
545
546
547
548
 
# File 'sagemaker/cfn_domain.rb', line 544

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


601
602
603
604
605
 
# File 'sagemaker/cfn_domain.rb', line 601

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



611
612
613
614
 
# File 'sagemaker/cfn_domain.rb', line 611

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



623
624
625
626
627
 
# File 'sagemaker/cfn_domain.rb', line 623

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#app_network_access_type ⇒ String?

Specifies the VPC used for non-EFS traffic.

The default value is PublicInternetOnly .

Returns:

  • (String, nil) 


355
356
357
 
# File 'sagemaker/cfn_domain.rb', line 355

def app_network_access_type()
  jsii_get_property("appNetworkAccessType")
end

#app_network_access_type=(value) ⇒ Object 



359
360
361
362
 
# File 'sagemaker/cfn_domain.rb', line 359

def app_network_access_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "appNetworkAccessType") unless value.nil?
  jsii_set_property("appNetworkAccessType", value)
end

#app_security_group_management ⇒ String?

The entity that creates and manages the required security groups for inter-app communication in VpcOnly mode.

Returns:

  • (String, nil) 


367
368
369
 
# File 'sagemaker/cfn_domain.rb', line 367

def app_security_group_management()
  jsii_get_property("appSecurityGroupManagement")
end

#app_security_group_management=(value) ⇒ Object 



371
372
373
374
 
# File 'sagemaker/cfn_domain.rb', line 371

def app_security_group_management=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "appSecurityGroupManagement") unless value.nil?
  jsii_set_property("appSecurityGroupManagement", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



636
637
638
639
 
# File 'sagemaker/cfn_domain.rb', line 636

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



658
659
660
661
662
663
 
# File 'sagemaker/cfn_domain.rb', line 658

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_domain_arn ⇒ String

The Amazon Resource Name (ARN) of the Domain, such as arn:aws:sagemaker:us-west-2:account-id:domain/my-domain-name .

Returns:

  • (String) 


251
252
253
 
# File 'sagemaker/cfn_domain.rb', line 251

def attr_domain_arn()
  jsii_get_property("attrDomainArn")
end

#attr_domain_id ⇒ String

The Domain ID.

Returns:

  • (String) 


258
259
260
 
# File 'sagemaker/cfn_domain.rb', line 258

def attr_domain_id()
  jsii_get_property("attrDomainId")
end

#attr_home_efs_file_system_id ⇒ String

The ID of the Amazon Elastic File System (EFS) managed by this Domain.

Returns:

  • (String) 


265
266
267
 
# File 'sagemaker/cfn_domain.rb', line 265

def attr_home_efs_file_system_id()
  jsii_get_property("attrHomeEfsFileSystemId")
end

#attr_security_group_id_for_domain_boundary ⇒ String

The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.

Returns:

  • (String) 


272
273
274
 
# File 'sagemaker/cfn_domain.rb', line 272

def attr_security_group_id_for_domain_boundary()
  jsii_get_property("attrSecurityGroupIdForDomainBoundary")
end

#attr_single_sign_on_application_arn ⇒ String

The ARN of the application managed by SageMaker in IAM Identity Center.

This value is only returned for domains created after October 1, 2023.

Returns:

  • (String) 


281
282
283
 
# File 'sagemaker/cfn_domain.rb', line 281

def attr_single_sign_on_application_arn()
  jsii_get_property("attrSingleSignOnApplicationArn")
end

#attr_single_sign_on_managed_application_instance_id ⇒ String

The SSO managed application instance ID.

Returns:

  • (String) 


288
289
290
 
# File 'sagemaker/cfn_domain.rb', line 288

def attr_single_sign_on_managed_application_instance_id()
  jsii_get_property("attrSingleSignOnManagedApplicationInstanceId")
end

#attr_url ⇒ String

The URL for the Domain.

Returns:

  • (String) 


295
296
297
 
# File 'sagemaker/cfn_domain.rb', line 295

def attr_url()
  jsii_get_property("attrUrl")
end

#auth_mode ⇒ String

The mode of authentication that members use to access the Domain.

Returns:

  • (String) 


316
317
318
 
# File 'sagemaker/cfn_domain.rb', line 316

def auth_mode()
  jsii_get_property("authMode")
end

#auth_mode=(value) ⇒ Object 



320
321
322
323
 
# File 'sagemaker/cfn_domain.rb', line 320

def auth_mode=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authMode")
  jsii_set_property("authMode", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



197
198
199
 
# File 'sagemaker/cfn_domain.rb', line 197

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


202
203
204
 
# File 'sagemaker/cfn_domain.rb', line 202

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


667
668
669
670
 
# File 'sagemaker/cfn_domain.rb', line 667

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


207
208
209
 
# File 'sagemaker/cfn_domain.rb', line 207

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


214
215
216
 
# File 'sagemaker/cfn_domain.rb', line 214

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


159
160
161
 
# File 'sagemaker/cfn_domain.rb', line 159

def creation_stack()
  jsii_get_property("creationStack")
end

#default_space_settings ⇒ AWSCDK::IResolvable, ...

The default settings for shared spaces that users create in the domain.

Returns:



379
380
381
 
# File 'sagemaker/cfn_domain.rb', line 379

def default_space_settings()
  jsii_get_property("defaultSpaceSettings")
end

#default_space_settings=(value) ⇒ Object 



383
384
385
386
387
 
# File 'sagemaker/cfn_domain.rb', line 383

def default_space_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnDomain::DefaultSpaceSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuRG9tYWluLkRlZmF1bHRTcGFjZVNldHRpbmdzUHJvcGVydHkifV19fQ==")), "defaultSpaceSettings") unless value.nil?
  jsii_set_property("defaultSpaceSettings", value)
end

#default_user_settings ⇒ AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnDomain::UserSettingsProperty

The default user settings.

Returns:



328
329
330
 
# File 'sagemaker/cfn_domain.rb', line 328

def ()
  jsii_get_property("defaultUserSettings")
end

#default_user_settings=(value) ⇒ Object 



332
333
334
335
336
 
# File 'sagemaker/cfn_domain.rb', line 332

def default_user_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnDomain::UserSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuRG9tYWluLlVzZXJTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "defaultUserSettings")
  jsii_set_property("defaultUserSettings", value)
end

#domain_name ⇒ String

The domain name.

Returns:

  • (String) 


341
342
343
 
# File 'sagemaker/cfn_domain.rb', line 341

def domain_name()
  jsii_get_property("domainName")
end

#domain_name=(value) ⇒ Object 



345
346
347
348
 
# File 'sagemaker/cfn_domain.rb', line 345

def domain_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainName")
  jsii_set_property("domainName", value)
end

#domain_ref ⇒ AWSCDK::Interfaces::AWSSagemaker::DomainReference

A reference to a Domain resource.

Returns:



302
303
304
 
# File 'sagemaker/cfn_domain.rb', line 302

def domain_ref()
  jsii_get_property("domainRef")
end

#domain_settings ⇒ AWSCDK::IResolvable, ...

A collection of settings that apply to the SageMaker Domain .

Returns:



392
393
394
 
# File 'sagemaker/cfn_domain.rb', line 392

def domain_settings()
  jsii_get_property("domainSettings")
end

#domain_settings=(value) ⇒ Object 



396
397
398
399
400
 
# File 'sagemaker/cfn_domain.rb', line 396

def domain_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnDomain::DomainSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuRG9tYWluLkRvbWFpblNldHRpbmdzUHJvcGVydHkifV19fQ==")), "domainSettings") unless value.nil?
  jsii_set_property("domainSettings", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



219
220
221
 
# File 'sagemaker/cfn_domain.rb', line 219

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



680
681
682
683
684
 
# File 'sagemaker/cfn_domain.rb', line 680

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



691
692
693
694
 
# File 'sagemaker/cfn_domain.rb', line 691

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#home_efs_file_system_creation ⇒ String?

Indicates whether a home EFS file system is created for the domain.

Returns:

  • (String, nil) 


405
406
407
 
# File 'sagemaker/cfn_domain.rb', line 405

def home_efs_file_system_creation()
  jsii_get_property("homeEfsFileSystemCreation")
end

#home_efs_file_system_creation=(value) ⇒ Object 



409
410
411
412
 
# File 'sagemaker/cfn_domain.rb', line 409

def home_efs_file_system_creation=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "homeEfsFileSystemCreation") unless value.nil?
  jsii_set_property("homeEfsFileSystemCreation", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



761
762
763
764
 
# File 'sagemaker/cfn_domain.rb', line 761

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#kms_key_id ⇒ String?

SageMaker uses AWS KMS to encrypt the EFS volume attached to the Domain with an AWS managed customer master key (CMK) by default.

Returns:

  • (String, nil) 


417
418
419
 
# File 'sagemaker/cfn_domain.rb', line 417

def kms_key_id()
  jsii_get_property("kmsKeyId")
end

#kms_key_id=(value) ⇒ Object 



421
422
423
424
 
# File 'sagemaker/cfn_domain.rb', line 421

def kms_key_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyId") unless value.nil?
  jsii_set_property("kmsKeyId", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


171
172
173
 
# File 'sagemaker/cfn_domain.rb', line 171

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


154
155
156
 
# File 'sagemaker/cfn_domain.rb', line 154

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



702
703
704
 
# File 'sagemaker/cfn_domain.rb', line 702

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



709
710
711
 
# File 'sagemaker/cfn_domain.rb', line 709

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



502
503
504
505
 
# File 'sagemaker/cfn_domain.rb', line 502

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


190
191
192
 
# File 'sagemaker/cfn_domain.rb', line 190

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



720
721
722
723
 
# File 'sagemaker/cfn_domain.rb', line 720

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


727
728
729
730
 
# File 'sagemaker/cfn_domain.rb', line 727

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



737
738
739
740
741
 
# File 'sagemaker/cfn_domain.rb', line 737

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



746
747
748
 
# File 'sagemaker/cfn_domain.rb', line 746

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



180
181
182
 
# File 'sagemaker/cfn_domain.rb', line 180

def stack()
  jsii_get_property("stack")
end

#subnet_ids ⇒ Array<String>?

The VPC subnets that Studio uses for communication.

Returns:

  • (Array<String>, nil) 


429
430
431
 
# File 'sagemaker/cfn_domain.rb', line 429

def subnet_ids()
  jsii_get_property("subnetIds")
end

#subnet_ids=(value) ⇒ Object 



433
434
435
436
 
# File 'sagemaker/cfn_domain.rb', line 433

def subnet_ids=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "subnetIds") unless value.nil?
  jsii_set_property("subnetIds", value)
end

#tag_propagation ⇒ String?

Indicates whether the tags added to Domain, User Profile and Space entity is propagated to all SageMaker resources.

Returns:

  • (String, nil) 


441
442
443
 
# File 'sagemaker/cfn_domain.rb', line 441

def tag_propagation()
  jsii_get_property("tagPropagation")
end

#tag_propagation=(value) ⇒ Object 



445
446
447
448
 
# File 'sagemaker/cfn_domain.rb', line 445

def tag_propagation=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tagPropagation") unless value.nil?
  jsii_set_property("tagPropagation", value)
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



309
310
311
 
# File 'sagemaker/cfn_domain.rb', line 309

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

Tags to associated with the Domain.

Returns:



453
454
455
 
# File 'sagemaker/cfn_domain.rb', line 453

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



457
458
459
460
461
 
# File 'sagemaker/cfn_domain.rb', line 457

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



478
479
480
 
# File 'sagemaker/cfn_domain.rb', line 478

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


227
228
229
 
# File 'sagemaker/cfn_domain.rb', line 227

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


237
238
239
 
# File 'sagemaker/cfn_domain.rb', line 237

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


752
753
754
755
 
# File 'sagemaker/cfn_domain.rb', line 752

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#vpc_id ⇒ String?

The ID of the Amazon Virtual Private Cloud (Amazon VPC) that Studio uses for communication.

Returns:

  • (String, nil) 


466
467
468
 
# File 'sagemaker/cfn_domain.rb', line 466

def vpc_id()
  jsii_get_property("vpcId")
end

#vpc_id=(value) ⇒ Object 



470
471
472
473
 
# File 'sagemaker/cfn_domain.rb', line 470

def vpc_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vpcId") unless value.nil?
  jsii_set_property("vpcId", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


491
492
493
494
495
496
 
# File 'sagemaker/cfn_domain.rb', line 491

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end