Class: AWSCDK::Sagemaker::CfnPartnerAppProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sagemaker/cfn_partner_app_props.rb

Overview

Properties for defining a CfnPartnerApp.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(auth_type:, execution_role_arn:, name:, tier:, type:, application_config: nil, app_version: nil, client_token: nil, enable_auto_minor_version_upgrade: nil, enable_iam_session_based_identity: nil, kms_key_id: nil, maintenance_config: nil, tags: nil) ⇒ CfnPartnerAppProps

Returns a new instance of CfnPartnerAppProps.

Parameters:

  • auth_type (String) —

    Defines the authentication type used for the Partner AI App.

  • execution_role_arn (String) —

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

  • name (String) —

    The name of the Partner AI App.

  • tier (String) —

    Specifies the tier or level of the Partner AI App.

  • type (String) —

    Specifies the type of Partner AI App being created.

  • application_config (AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnPartnerApp::PartnerAppConfigProperty, nil) (defaults to: nil) —

    Configuration settings for the Partner AI App.

  • app_version (String, nil) (defaults to: nil) —

    The version of the PartnerApp.

  • client_token (String, nil) (defaults to: nil) —

    The client token for the PartnerApp.

  • enable_auto_minor_version_upgrade (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Enables automatic minor version upgrades for the PartnerApp.

  • enable_iam_session_based_identity (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Enables IAM Session based Identity for PartnerApp.

  • kms_key_id (String, nil) (defaults to: nil) —

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

  • maintenance_config (AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnPartnerApp::PartnerAppMaintenanceConfigProperty, nil) (defaults to: nil) —

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

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    A list of tags to apply to the PartnerApp.



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'sagemaker/cfn_partner_app_props.rb', line 22

def initialize(auth_type:, execution_role_arn:, name:, tier:, type:, application_config: nil, app_version: nil, client_token: nil, enable_auto_minor_version_upgrade: nil, enable_iam_session_based_identity: nil, kms_key_id: nil, maintenance_config: nil, tags: nil)
  @auth_type = auth_type
  Jsii::Type.check_type(@auth_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authType")
  @execution_role_arn = execution_role_arn
  Jsii::Type.check_type(@execution_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "executionRoleArn")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @tier = tier
  Jsii::Type.check_type(@tier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tier")
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @application_config = application_config.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnPartnerApp::PartnerAppConfigProperty.new(**application_config.transform_keys(&:to_sym)) : application_config
  Jsii::Type.check_type(@application_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuUGFydG5lckFwcC5QYXJ0bmVyQXBwQ29uZmlnUHJvcGVydHkifV19fQ==")), "applicationConfig") unless @application_config.nil?
  @app_version = app_version
  Jsii::Type.check_type(@app_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "appVersion") unless @app_version.nil?
  @client_token = client_token
  Jsii::Type.check_type(@client_token, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientToken") unless @client_token.nil?
  @enable_auto_minor_version_upgrade = enable_auto_minor_version_upgrade
  Jsii::Type.check_type(@enable_auto_minor_version_upgrade, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableAutoMinorVersionUpgrade") unless @enable_auto_minor_version_upgrade.nil?
  @enable_iam_session_based_identity = enable_iam_session_based_identity
  Jsii::Type.check_type(@enable_iam_session_based_identity, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableIamSessionBasedIdentity") unless @enable_iam_session_based_identity.nil?
  @kms_key_id = kms_key_id
  Jsii::Type.check_type(@kms_key_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyId") unless @kms_key_id.nil?
  @maintenance_config = maintenance_config.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnPartnerApp::PartnerAppMaintenanceConfigProperty.new(**maintenance_config.transform_keys(&:to_sym)) : maintenance_config
  Jsii::Type.check_type(@maintenance_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuUGFydG5lckFwcC5QYXJ0bmVyQXBwTWFpbnRlbmFuY2VDb25maWdQcm9wZXJ0eSJ9XX19")), "maintenanceConfig") unless @maintenance_config.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#app_version ⇒ String? (readonly)

The version of the PartnerApp.

Returns:

  • (String, nil)

See Also:



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

def app_version
  @app_version
end

#application_config ⇒ AWSCDK::IResolvable, ... (readonly)

Configuration settings for the Partner AI App.

Returns:

See Also:



84
85
86
 
# File 'sagemaker/cfn_partner_app_props.rb', line 84

def application_config
  @application_config
end

#auth_type ⇒ String (readonly)

Defines the authentication type used for the Partner AI App.

Returns:

  • (String)

See Also:



55
56
57
 
# File 'sagemaker/cfn_partner_app_props.rb', line 55

def auth_type
  @auth_type
end

#client_token ⇒ String? (readonly)

Deprecated.

this property has been deprecated

The client token for the PartnerApp.

Returns:

  • (String, nil)

See Also:



95
96
97
 
# File 'sagemaker/cfn_partner_app_props.rb', line 95

def client_token
  @client_token
end

#enable_auto_minor_version_upgrade ⇒ Boolean, ... (readonly)

Enables automatic minor version upgrades for the PartnerApp.

Returns:

See Also:



100
101
102
 
# File 'sagemaker/cfn_partner_app_props.rb', line 100

def enable_auto_minor_version_upgrade
  @enable_auto_minor_version_upgrade
end

#enable_iam_session_based_identity ⇒ Boolean, ... (readonly)

Enables IAM Session based Identity for PartnerApp.

Returns:

See Also:



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

def enable_iam_session_based_identity
  @enable_iam_session_based_identity
end

#execution_role_arn ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



60
61
62
 
# File 'sagemaker/cfn_partner_app_props.rb', line 60

def execution_role_arn
  @execution_role_arn
end

#kms_key_id ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



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

def kms_key_id
  @kms_key_id
end

#maintenance_config ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



115
116
117
 
# File 'sagemaker/cfn_partner_app_props.rb', line 115

def maintenance_config
  @maintenance_config
end

#name ⇒ String (readonly)

The name of the Partner AI App.

This name must be unique within your account and region.

Returns:

  • (String)

See Also:



67
68
69
 
# File 'sagemaker/cfn_partner_app_props.rb', line 67

def name
  @name
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

A list of tags to apply to the PartnerApp.

Returns:

See Also:



120
121
122
 
# File 'sagemaker/cfn_partner_app_props.rb', line 120

def tags
  @tags
end

#tier ⇒ String (readonly)

Specifies the tier or level of the Partner AI App.

The tier size impacts the speed and capabilities of the application. For more information, see Set up Partner AI Apps .

Returns:

  • (String)

See Also:



74
75
76
 
# File 'sagemaker/cfn_partner_app_props.rb', line 74

def tier
  @tier
end

#type ⇒ String (readonly)

Specifies the type of Partner AI App being created.

Returns:

  • (String)

See Also:



79
80
81
 
# File 'sagemaker/cfn_partner_app_props.rb', line 79

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'sagemaker/cfn_partner_app_props.rb', line 122

def self.jsii_properties
  {
    :auth_type => "authType",
    :execution_role_arn => "executionRoleArn",
    :name => "name",
    :tier => "tier",
    :type => "type",
    :application_config => "applicationConfig",
    :app_version => "appVersion",
    :client_token => "clientToken",
    :enable_auto_minor_version_upgrade => "enableAutoMinorVersionUpgrade",
    :enable_iam_session_based_identity => "enableIamSessionBasedIdentity",
    :kms_key_id => "kmsKeyId",
    :maintenance_config => "maintenanceConfig",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'sagemaker/cfn_partner_app_props.rb', line 140

def to_jsii
  result = {}
  result.merge!({
    "authType" => @auth_type,
    "executionRoleArn" => @execution_role_arn,
    "name" => @name,
    "tier" => @tier,
    "type" => @type,
    "applicationConfig" => @application_config,
    "appVersion" => @app_version,
    "clientToken" => @client_token,
    "enableAutoMinorVersionUpgrade" => @enable_auto_minor_version_upgrade,
    "enableIamSessionBasedIdentity" => @enable_iam_session_based_identity,
    "kmsKeyId" => @kms_key_id,
    "maintenanceConfig" => @maintenance_config,
    "tags" => @tags,
  })
  result.compact
end