Class: AWSCDK::OpenSearchServerless::CfnSecurityConfig

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSOpensearchserverless::ISecurityConfigRef
Defined in:
open_search_serverless/cfn_security_config.rb

Overview

Specifies a security configuration for OpenSearch Serverless.

For more information, see SAML authentication for Amazon OpenSearch Serverless .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnSecurityConfig

Create a new AWS::OpenSearchServerless::SecurityConfig.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::OpenSearchServerless::CfnSecurityConfigProps, nil) (defaults to: nil) —

    Resource properties.



19
20
21
22
23
24
25
 
# File 'open_search_serverless/cfn_security_config.rb', line 19

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::OpenSearchServerless::CfnSecurityConfigProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfb3BlbnNlYXJjaHNlcnZlcmxlc3MuQ2ZuU2VjdXJpdHlDb25maWdQcm9wcyJ9")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


180
181
182
 
# File 'open_search_serverless/cfn_security_config.rb', line 180

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

.is_cfn_security_config(x) ⇒ Boolean

Checks whether the given object is a CfnSecurityConfig.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


82
83
84
85
 
# File 'open_search_serverless/cfn_security_config.rb', line 82

def self.is_cfn_security_config(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_opensearchserverless.CfnSecurityConfig", "isCfnSecurityConfig", [x])
end

.jsii_overridable_methods ⇒ Object 



27
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
 
# File 'open_search_serverless/cfn_security_config.rb', line 27

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_iam_identity_center_options_application_arn => { kind: :property, name: "attrIamIdentityCenterOptionsApplicationArn", is_optional: false },
    :attr_iam_identity_center_options_application_description => { kind: :property, name: "attrIamIdentityCenterOptionsApplicationDescription", is_optional: false },
    :attr_iam_identity_center_options_application_name => { kind: :property, name: "attrIamIdentityCenterOptionsApplicationName", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :security_config_ref => { kind: :property, name: "securityConfigRef", is_optional: false },
    :description => { kind: :property, name: "description", is_optional: true },
    :iam_federation_options => { kind: :property, name: "iamFederationOptions", is_optional: true },
    :iam_identity_center_options => { kind: :property, name: "iamIdentityCenterOptions", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :saml_options => { kind: :property, name: "samlOptions", is_optional: true },
    :type => { kind: :property, name: "type", 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.



332
333
334
335
 
# File 'open_search_serverless/cfn_security_config.rb', line 332

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:



344
345
346
347
 
# File 'open_search_serverless/cfn_security_config.rb', line 344

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:



354
355
356
357
 
# File 'open_search_serverless/cfn_security_config.rb', line 354

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:



365
366
367
368
369
 
# File 'open_search_serverless/cfn_security_config.rb', line 365

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.


422
423
424
425
426
 
# File 'open_search_serverless/cfn_security_config.rb', line 422

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.



432
433
434
435
 
# File 'open_search_serverless/cfn_security_config.rb', line 432

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.



444
445
446
447
448
 
# File 'open_search_serverless/cfn_security_config.rb', line 444

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

#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:



457
458
459
460
 
# File 'open_search_serverless/cfn_security_config.rb', line 457

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:



479
480
481
482
483
484
 
# File 'open_search_serverless/cfn_security_config.rb', line 479

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

The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless.

Returns:

  • (String) 


187
188
189
 
# File 'open_search_serverless/cfn_security_config.rb', line 187

def attr_iam_identity_center_options_application_arn()
  jsii_get_property("attrIamIdentityCenterOptionsApplicationArn")
end

#attr_iam_identity_center_options_application_description ⇒ String

The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.

Returns:

  • (String) 


194
195
196
 
# File 'open_search_serverless/cfn_security_config.rb', line 194

def attr_iam_identity_center_options_application_description()
  jsii_get_property("attrIamIdentityCenterOptionsApplicationDescription")
end

#attr_iam_identity_center_options_application_name ⇒ String

The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.

Returns:

  • (String) 


201
202
203
 
# File 'open_search_serverless/cfn_security_config.rb', line 201

def attr_iam_identity_center_options_application_name()
  jsii_get_property("attrIamIdentityCenterOptionsApplicationName")
end

#attr_id ⇒ String

The unique identifier of the security configuration.

For example, saml/123456789012/myprovider .

Returns:

  • (String) 


210
211
212
 
# File 'open_search_serverless/cfn_security_config.rb', line 210

def attr_id()
  jsii_get_property("attrId")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



133
134
135
 
# File 'open_search_serverless/cfn_security_config.rb', line 133

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


138
139
140
 
# File 'open_search_serverless/cfn_security_config.rb', line 138

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


488
489
490
491
 
# File 'open_search_serverless/cfn_security_config.rb', line 488

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


143
144
145
 
# File 'open_search_serverless/cfn_security_config.rb', line 143

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


150
151
152
 
# File 'open_search_serverless/cfn_security_config.rb', line 150

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


95
96
97
 
# File 'open_search_serverless/cfn_security_config.rb', line 95

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The description of the security configuration.

Returns:

  • (String, nil) 


224
225
226
 
# File 'open_search_serverless/cfn_security_config.rb', line 224

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



228
229
230
231
 
# File 'open_search_serverless/cfn_security_config.rb', line 228

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



155
156
157
 
# File 'open_search_serverless/cfn_security_config.rb', line 155

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:



501
502
503
504
505
 
# File 'open_search_serverless/cfn_security_config.rb', line 501

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:



512
513
514
515
 
# File 'open_search_serverless/cfn_security_config.rb', line 512

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

#iam_federation_options ⇒ AWSCDK::IResolvable, ...

Describes IAM federation options in the form of a key-value map.

Returns:



236
237
238
 
# File 'open_search_serverless/cfn_security_config.rb', line 236

def iam_federation_options()
  jsii_get_property("iamFederationOptions")
end

#iam_federation_options=(value) ⇒ Object 



240
241
242
243
244
 
# File 'open_search_serverless/cfn_security_config.rb', line 240

def iam_federation_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OpenSearchServerless::CfnSecurityConfig::IAMFederationConfigOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmVybGVzcy5DZm5TZWN1cml0eUNvbmZpZy5JYW1GZWRlcmF0aW9uQ29uZmlnT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "iamFederationOptions") unless value.nil?
  jsii_set_property("iamFederationOptions", value)
end

#iam_identity_center_options ⇒ AWSCDK::IResolvable, ...

Describes IAM Identity Center options in the form of a key-value map.

Returns:



249
250
251
 
# File 'open_search_serverless/cfn_security_config.rb', line 249

def iam_identity_center_options()
  jsii_get_property("iamIdentityCenterOptions")
end

#iam_identity_center_options=(value) ⇒ Object 



253
254
255
256
257
 
# File 'open_search_serverless/cfn_security_config.rb', line 253

def iam_identity_center_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OpenSearchServerless::CfnSecurityConfig::IAMIdentityCenterConfigOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmVybGVzcy5DZm5TZWN1cml0eUNvbmZpZy5JYW1JZGVudGl0eUNlbnRlckNvbmZpZ09wdGlvbnNQcm9wZXJ0eSJ9XX19")), "iamIdentityCenterOptions") unless value.nil?
  jsii_set_property("iamIdentityCenterOptions", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



582
583
584
585
 
# File 'open_search_serverless/cfn_security_config.rb', line 582

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


107
108
109
 
# File 'open_search_serverless/cfn_security_config.rb', line 107

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String?

The name of the security configuration.

Returns:

  • (String, nil) 


262
263
264
 
# File 'open_search_serverless/cfn_security_config.rb', line 262

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



266
267
268
269
 
# File 'open_search_serverless/cfn_security_config.rb', line 266

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


90
91
92
 
# File 'open_search_serverless/cfn_security_config.rb', line 90

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:



523
524
525
 
# File 'open_search_serverless/cfn_security_config.rb', line 523

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:



530
531
532
 
# File 'open_search_serverless/cfn_security_config.rb', line 530

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.



323
324
325
326
 
# File 'open_search_serverless/cfn_security_config.rb', line 323

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) 


126
127
128
 
# File 'open_search_serverless/cfn_security_config.rb', line 126

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:



541
542
543
544
 
# File 'open_search_serverless/cfn_security_config.rb', line 541

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


548
549
550
551
 
# File 'open_search_serverless/cfn_security_config.rb', line 548

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:



558
559
560
561
562
 
# File 'open_search_serverless/cfn_security_config.rb', line 558

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

#saml_options ⇒ AWSCDK::IResolvable, ...

SAML options for the security configuration in the form of a key-value map.

Returns:



274
275
276
 
# File 'open_search_serverless/cfn_security_config.rb', line 274

def saml_options()
  jsii_get_property("samlOptions")
end

#saml_options=(value) ⇒ Object 



278
279
280
281
282
 
# File 'open_search_serverless/cfn_security_config.rb', line 278

def saml_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OpenSearchServerless::CfnSecurityConfig::SamlConfigOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmVybGVzcy5DZm5TZWN1cml0eUNvbmZpZy5TYW1sQ29uZmlnT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "samlOptions") unless value.nil?
  jsii_set_property("samlOptions", value)
end

#security_config_ref ⇒ AWSCDK::Interfaces::AWSOpensearchserverless::SecurityConfigReference

A reference to a SecurityConfig resource.

Returns:



217
218
219
 
# File 'open_search_serverless/cfn_security_config.rb', line 217

def security_config_ref()
  jsii_get_property("securityConfigRef")
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.



567
568
569
 
# File 'open_search_serverless/cfn_security_config.rb', line 567

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:



116
117
118
 
# File 'open_search_serverless/cfn_security_config.rb', line 116

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



299
300
301
 
# File 'open_search_serverless/cfn_security_config.rb', line 299

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

#type ⇒ String?

The type of security configuration.

Returns:

  • (String, nil) 


287
288
289
 
# File 'open_search_serverless/cfn_security_config.rb', line 287

def type()
  jsii_get_property("type")
end

#type=(value) ⇒ Object 



291
292
293
294
 
# File 'open_search_serverless/cfn_security_config.rb', line 291

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


163
164
165
 
# File 'open_search_serverless/cfn_security_config.rb', line 163

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


173
174
175
 
# File 'open_search_serverless/cfn_security_config.rb', line 173

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


573
574
575
576
 
# File 'open_search_serverless/cfn_security_config.rb', line 573

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) 


312
313
314
315
316
317
 
# File 'open_search_serverless/cfn_security_config.rb', line 312

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