Protected Readonly Internal_AWS CloudFormation resource properties.
This object is returned via cfnProperties
OptionalappSpecifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly .
OptionalappThe entity that creates and manages the required security groups for inter-app communication in VpcOnly mode.
ReadonlyattrThe Amazon Resource Name (ARN) of the Domain, such as arn:aws:sagemaker:us-west-2:account-id:domain/my-domain-name .
ReadonlyattrThe Domain ID.
ReadonlyattrThe ID of the Amazon Elastic File System (EFS) managed by this Domain.
ReadonlyattrThe ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.
ReadonlyattrThe ARN of the application managed by SageMaker in IAM Identity Center. This value is only returned for domains created after October 1, 2023.
ReadonlyattrThe IAM Identity Center managed application instance ID.
ReadonlyattrThe URL for the Domain.
The mode of authentication that members use to access the Domain.
ReadonlycfnOptions for this resource, such as condition, update policy etc.
ReadonlycfnAWS resource type.
OptionaldefaultThe default settings for shared spaces that users create in the domain.
The default user settings.
The domain name.
OptionaldomainA collection of settings that apply to the SageMaker Domain .
OptionalkmsSageMaker uses AWS KMS to encrypt the EFS volume attached to the Domain with an AWS managed customer master key (CMK) by default.
ReadonlylogicalThe 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 overrideLogicalId(newLogicalId).
ReadonlynodeThe tree node.
ReadonlystackThe stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly).
OptionalsubnetThe VPC subnets that Studio uses for communication.
OptionaltagIndicates whether the tags added to Domain, User Profile and Space entity is propagated to all SageMaker resources.
ReadonlytagsTag Manager which manages the tags for this resource
OptionaltagsTags to associated with the Domain.
OptionalvpcThe ID of the Amazon Virtual Private Cloud (Amazon VPC) that Studio uses for communication.
Static ReadonlyCFN_The CloudFormation resource type name for this resource class.
Protectedcfnthe stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
A reference to a Domain resource.
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 }).
ProtectedupdatedProtectedupdatedReturn properties modified after initiation
Resources that expose mutable properties should override this function to collect and return the properties object for this resource.
InternalCalled by the addDependency helper function in order to realize a direct
dependency between two resources that are directly defined in the same
stacks.
Use resource.addDependency to define the dependency between two resources,
which also takes stack boundaries into account.
InternalLock the logicalId of the element and do not allow any updates (e.g. via overrideLogicalId)
This is needed in cases where you are consuming the LogicalID of an element prior to synthesis and you need to not allow future changes to the id since doing so would cause the value you just consumed to differ from the synth time value of the logicalId.
For example:
const bucket = new Bucket(stack, 'Bucket'); stack.exportValue(bucket.bucketArn) <--- consuming the logicalId bucket.overrideLogicalId('NewLogicalId') <--- updating logicalId
You should most likely never need to use this method, and if you are implementing a feature that requires this, make sure you actually require it.
InternalRemove a dependency between this resource and other resources in the same stack.
InternalEmits CloudFormation for this resource.
Syntactic sugar for addOverride(path, undefined).
The path of the value to delete
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.
Add a value to the CloudFormation Resource Metadata
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
Adds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride 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,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value argument to addOverride 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.
The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
The value. Could be primitive or complex.
Adds an override that deletes the value of a property from the resource definition.
The path to the property.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value).
The path of the property
The 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:
Optionaloptions: RemovalPolicyOptionsReturns 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.
The name of the attribute.
OptionaltypeHint: ResolutionTypeHintRetrieve a value value from the CloudFormation Resource Metadata
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
Examines the CloudFormation resource and discloses attributes
tree inspector to collect and process attributes
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
Get a shallow copy of dependencies between this resource and other resources in the same stack.
Overrides the auto-generated logical ID with a specific ID.
The new logical ID to use for this stack element.
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.
ProtectedrenderReplaces one dependency with another.
The dependency to replace
The new dependency to add
ProtectedshouldCan be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
true if the resource should be included or false is the resource
should be omitted.
a string representation of this resource
ProtectedvalidateStatic_InternalBuild a CfnDomain from CloudFormation properties
A factory method that creates a new instance of this class from an object containing the CloudFormation properties of this resource. Used in the @aws-cdk/cloudformation-include module.
StaticfromCreates a new IDomainRef from an ARN
StaticfromCreates a new IDomainRef from a domainId
StaticisReturns true if a construct is a stack element (i.e. part of the
synthesized cloudformation template).
Uses duck-typing instead of instanceof to allow stack elements from different
versions of this library to be included in the same stack.
The construct as a stack element or undefined if it is not a stack element.
StaticisCheck whether the given object is a CfnResource
StaticisChecks if x is a construct.
Use this method instead of instanceof to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct in each copy of the constructs library
is seen as a different class, and an instance of one class will not test as
instanceof the other class. npm install will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof will behave
unpredictably. It is safest to avoid using instanceof, and using
this type-testing method instead.
Any object
true if x is an object created from a class which extends Construct.
A construct for creating a compliant Studio Domain resource. Specifically, the construct ensures that the Studio Domain EFS volume is encrypted, that the Domain is VPC bound, and that Domain App traffic is controlled via Security Groups. Additionally, a custom resource is used to ensure that the domain ExecutionRoleIdentityConfig is set to USER_PROFILE_NAME.