Class: AWSCDK::Sagemaker::CfnPartnerApp

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSSagemaker::IPartnerAppRef
Defined in:
sagemaker/cfn_partner_app.rb

Overview

The AWS::SageMaker::PartnerApp resource creates an Amazon SageMaker Partner AI App.

For more information, see Partner AI Apps .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnPartnerApp

Create a new AWS::SageMaker::PartnerApp.

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::CfnPartnerAppProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'sagemaker/cfn_partner_app.rb', line 20

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnPartnerAppProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2FnZW1ha2VyLkNmblBhcnRuZXJBcHBQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_partner_app(resource) ⇒ String

Parameters:

Returns:

  • (String) 


88
89
90
91
 
# File 'sagemaker/cfn_partner_app.rb', line 88

def self.arn_for_partner_app(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zYWdlbWFrZXIuSVBhcnRuZXJBcHBSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_sagemaker.CfnPartnerApp", "arnForPartnerApp", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


195
196
197
 
# File 'sagemaker/cfn_partner_app.rb', line 195

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

.is_cfn_partner_app(x) ⇒ Boolean

Checks whether the given object is a CfnPartnerApp.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


97
98
99
100
 
# File 'sagemaker/cfn_partner_app.rb', line 97

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

.jsii_overridable_methods ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
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
 
# File 'sagemaker/cfn_partner_app.rb', line 28

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_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_base_url => { kind: :property, name: "attrBaseUrl", is_optional: false },
    :attr_current_version_eol_date => { kind: :property, name: "attrCurrentVersionEolDate", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :partner_app_ref => { kind: :property, name: "partnerAppRef", is_optional: false },
    :auth_type => { kind: :property, name: "authType", is_optional: false },
    :execution_role_arn => { kind: :property, name: "executionRoleArn", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :tier => { kind: :property, name: "tier", is_optional: false },
    :type => { kind: :property, name: "type", is_optional: false },
    :application_config => { kind: :property, name: "applicationConfig", is_optional: true },
    :app_version => { kind: :property, name: "appVersion", is_optional: true },
    :client_token => { kind: :property, name: "clientToken", is_optional: true },
    :enable_auto_minor_version_upgrade => { kind: :property, name: "enableAutoMinorVersionUpgrade", is_optional: true },
    :enable_iam_session_based_identity => { kind: :property, name: "enableIamSessionBasedIdentity", is_optional: true },
    :kms_key_id => { kind: :property, name: "kmsKeyId", is_optional: true },
    :maintenance_config => { kind: :property, name: "maintenanceConfig", is_optional: true },
    :tags => { kind: :property, name: "tags", 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.



430
431
432
433
 
# File 'sagemaker/cfn_partner_app.rb', line 430

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:



442
443
444
445
 
# File 'sagemaker/cfn_partner_app.rb', line 442

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:



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

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:



463
464
465
466
467
 
# File 'sagemaker/cfn_partner_app.rb', line 463

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.


520
521
522
523
524
 
# File 'sagemaker/cfn_partner_app.rb', line 520

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.



530
531
532
533
 
# File 'sagemaker/cfn_partner_app.rb', line 530

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.



542
543
544
545
546
 
# File 'sagemaker/cfn_partner_app.rb', line 542

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_version ⇒ String?

The version of the PartnerApp.

Returns:

  • (String, nil) 


310
311
312
 
# File 'sagemaker/cfn_partner_app.rb', line 310

def app_version()
  jsii_get_property("appVersion")
end

#app_version=(value) ⇒ Object 



314
315
316
317
 
# File 'sagemaker/cfn_partner_app.rb', line 314

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

#application_config ⇒ AWSCDK::IResolvable, ...

Configuration settings for the Partner AI App.

Returns:



297
298
299
 
# File 'sagemaker/cfn_partner_app.rb', line 297

def application_config()
  jsii_get_property("applicationConfig")
end

#application_config=(value) ⇒ Object 



301
302
303
304
305
 
# File 'sagemaker/cfn_partner_app.rb', line 301

def application_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnPartnerApp::PartnerAppConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuUGFydG5lckFwcC5QYXJ0bmVyQXBwQ29uZmlnUHJvcGVydHkifV19fQ==")), "applicationConfig") unless value.nil?
  jsii_set_property("applicationConfig", 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:



555
556
557
558
 
# File 'sagemaker/cfn_partner_app.rb', line 555

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:



577
578
579
580
581
582
 
# File 'sagemaker/cfn_partner_app.rb', line 577

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_arn ⇒ String

The Amazon Resource Name (ARN) of the created PartnerApp.

Returns:

  • (String) 


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

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_base_url ⇒ String

The AppServerUrl based on app and account-info.

Returns:

  • (String) 


209
210
211
 
# File 'sagemaker/cfn_partner_app.rb', line 209

def attr_base_url()
  jsii_get_property("attrBaseUrl")
end

#attr_current_version_eol_date ⇒ String

The end-of-life date for the current version of the PartnerApp.

Returns:

  • (String) 


216
217
218
 
# File 'sagemaker/cfn_partner_app.rb', line 216

def attr_current_version_eol_date()
  jsii_get_property("attrCurrentVersionEolDate")
end

#auth_type ⇒ String

Defines the authentication type used for the Partner AI App.

Returns:

  • (String) 


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

def auth_type()
  jsii_get_property("authType")
end

#auth_type=(value) ⇒ Object 



241
242
243
244
 
# File 'sagemaker/cfn_partner_app.rb', line 241

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

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



223
224
225
 
# File 'sagemaker/cfn_partner_app.rb', line 223

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



148
149
150
 
# File 'sagemaker/cfn_partner_app.rb', line 148

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


153
154
155
 
# File 'sagemaker/cfn_partner_app.rb', line 153

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


586
587
588
589
 
# File 'sagemaker/cfn_partner_app.rb', line 586

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}) 


158
159
160
 
# File 'sagemaker/cfn_partner_app.rb', line 158

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


165
166
167
 
# File 'sagemaker/cfn_partner_app.rb', line 165

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#client_token ⇒ String?

Deprecated.

this property has been deprecated

The client token for the PartnerApp.

Returns:

  • (String, nil) 


323
324
325
 
# File 'sagemaker/cfn_partner_app.rb', line 323

def client_token()
  jsii_get_property("clientToken")
end

#client_token=(value) ⇒ Object 



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

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


110
111
112
 
# File 'sagemaker/cfn_partner_app.rb', line 110

def creation_stack()
  jsii_get_property("creationStack")
end

#enable_auto_minor_version_upgrade ⇒ Boolean, ...

Enables automatic minor version upgrades for the PartnerApp.

Returns:



335
336
337
 
# File 'sagemaker/cfn_partner_app.rb', line 335

def enable_auto_minor_version_upgrade()
  jsii_get_property("enableAutoMinorVersionUpgrade")
end

#enable_auto_minor_version_upgrade=(value) ⇒ Object 



339
340
341
342
 
# File 'sagemaker/cfn_partner_app.rb', line 339

def enable_auto_minor_version_upgrade=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableAutoMinorVersionUpgrade") unless value.nil?
  jsii_set_property("enableAutoMinorVersionUpgrade", value)
end

#enable_iam_session_based_identity ⇒ Boolean, ...

Enables IAM Session based Identity for PartnerApp.

Returns:



347
348
349
 
# File 'sagemaker/cfn_partner_app.rb', line 347

def enable_iam_session_based_identity()
  jsii_get_property("enableIamSessionBasedIdentity")
end

#enable_iam_session_based_identity=(value) ⇒ Object 



351
352
353
354
 
# File 'sagemaker/cfn_partner_app.rb', line 351

def enable_iam_session_based_identity=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableIamSessionBasedIdentity") unless value.nil?
  jsii_set_property("enableIamSessionBasedIdentity", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



170
171
172
 
# File 'sagemaker/cfn_partner_app.rb', line 170

def env()
  jsii_get_property("env")
end

#execution_role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role of the user.

Returns:

  • (String) 


249
250
251
 
# File 'sagemaker/cfn_partner_app.rb', line 249

def execution_role_arn()
  jsii_get_property("executionRoleArn")
end

#execution_role_arn=(value) ⇒ Object 



253
254
255
256
 
# File 'sagemaker/cfn_partner_app.rb', line 253

def execution_role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "executionRoleArn")
  jsii_set_property("executionRoleArn", value)
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:



599
600
601
602
603
 
# File 'sagemaker/cfn_partner_app.rb', line 599

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:



610
611
612
613
 
# File 'sagemaker/cfn_partner_app.rb', line 610

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



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

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?

The AWS KMS customer managed key used to encrypt the data associated with the PartnerApp.

Returns:

  • (String, nil) 


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

def kms_key_id()
  jsii_get_property("kmsKeyId")
end

#kms_key_id=(value) ⇒ Object 



363
364
365
366
 
# File 'sagemaker/cfn_partner_app.rb', line 363

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) 


122
123
124
 
# File 'sagemaker/cfn_partner_app.rb', line 122

def logical_id()
  jsii_get_property("logicalId")
end

#maintenance_config ⇒ AWSCDK::IResolvable, ...

A collection of settings that specify the maintenance schedule for the PartnerApp.

Returns:



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

def maintenance_config()
  jsii_get_property("maintenanceConfig")
end

#maintenance_config=(value) ⇒ Object 



375
376
377
378
379
 
# File 'sagemaker/cfn_partner_app.rb', line 375

def maintenance_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnPartnerApp::PartnerAppMaintenanceConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuUGFydG5lckFwcC5QYXJ0bmVyQXBwTWFpbnRlbmFuY2VDb25maWdQcm9wZXJ0eSJ9XX19")), "maintenanceConfig") unless value.nil?
  jsii_set_property("maintenanceConfig", value)
end

#name ⇒ String

The name of the Partner AI App.

Returns:

  • (String) 


261
262
263
 
# File 'sagemaker/cfn_partner_app.rb', line 261

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



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

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


105
106
107
 
# File 'sagemaker/cfn_partner_app.rb', line 105

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:



621
622
623
 
# File 'sagemaker/cfn_partner_app.rb', line 621

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:



628
629
630
 
# File 'sagemaker/cfn_partner_app.rb', line 628

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.



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

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

#partner_app_ref ⇒ AWSCDK::Interfaces::AWSSagemaker::PartnerAppReference

A reference to a PartnerApp resource.

Returns:



230
231
232
 
# File 'sagemaker/cfn_partner_app.rb', line 230

def partner_app_ref()
  jsii_get_property("partnerAppRef")
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) 


141
142
143
 
# File 'sagemaker/cfn_partner_app.rb', line 141

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:



639
640
641
642
 
# File 'sagemaker/cfn_partner_app.rb', line 639

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}) 


646
647
648
649
 
# File 'sagemaker/cfn_partner_app.rb', line 646

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:



656
657
658
659
660
 
# File 'sagemaker/cfn_partner_app.rb', line 656

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.



665
666
667
 
# File 'sagemaker/cfn_partner_app.rb', line 665

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:



131
132
133
 
# File 'sagemaker/cfn_partner_app.rb', line 131

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

A list of tags to apply to the PartnerApp.

Returns:



384
385
386
 
# File 'sagemaker/cfn_partner_app.rb', line 384

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



388
389
390
391
392
 
# File 'sagemaker/cfn_partner_app.rb', line 388

def tags=(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=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#tier ⇒ String

Specifies the tier or level of the Partner AI App.

Returns:

  • (String) 


273
274
275
 
# File 'sagemaker/cfn_partner_app.rb', line 273

def tier()
  jsii_get_property("tier")
end

#tier=(value) ⇒ Object 



277
278
279
280
 
# File 'sagemaker/cfn_partner_app.rb', line 277

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



397
398
399
 
# File 'sagemaker/cfn_partner_app.rb', line 397

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

#type ⇒ String

Specifies the type of Partner AI App being created.

Returns:

  • (String) 


285
286
287
 
# File 'sagemaker/cfn_partner_app.rb', line 285

def type()
  jsii_get_property("type")
end

#type=(value) ⇒ Object 



289
290
291
292
 
# File 'sagemaker/cfn_partner_app.rb', line 289

def type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  jsii_set_property("type", value)
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}) 


178
179
180
 
# File 'sagemaker/cfn_partner_app.rb', line 178

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}) 


188
189
190
 
# File 'sagemaker/cfn_partner_app.rb', line 188

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


671
672
673
674
 
# File 'sagemaker/cfn_partner_app.rb', line 671

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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) 


410
411
412
413
414
415
 
# File 'sagemaker/cfn_partner_app.rb', line 410

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