Class: AWSCDK::RAM::CfnResourceShare

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSRAM::IResourceShareRef
Defined in:
ram/cfn_resource_share.rb

Overview

Creates a resource share.

You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.

Sharing a resource makes it available for use by principals outside of the AWS account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnResourceShare

Create a new AWS::RAM::ResourceShare.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::RAM::CfnResourceShareProps) —

    Resource properties.



22
23
24
25
26
27
28
 
# File 'ram/cfn_resource_share.rb', line 22

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

Class Method Details

.arn_for_resource_share(resource) ⇒ String

Parameters:

Returns:

  • (String) 


88
89
90
91
 
# File 'ram/cfn_resource_share.rb', line 88

def self.arn_for_resource_share(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19yYW0uSVJlc291cmNlU2hhcmVSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ram.CfnResourceShare", "arnForResourceShare", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


195
196
197
 
# File 'ram/cfn_resource_share.rb', line 195

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

.is_cfn_resource_share(x) ⇒ Boolean

Checks whether the given object is a CfnResourceShare.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


97
98
99
100
 
# File 'ram/cfn_resource_share.rb', line 97

def self.is_cfn_resource_share(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ram.CfnResourceShare", "isCfnResourceShare", [x])
end

.jsii_overridable_methods ⇒ Object 



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 'ram/cfn_resource_share.rb', line 30

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_creation_time => { kind: :property, name: "attrCreationTime", is_optional: false },
    :attr_feature_set => { kind: :property, name: "attrFeatureSet", is_optional: false },
    :attr_last_updated_time => { kind: :property, name: "attrLastUpdatedTime", is_optional: false },
    :attr_owning_account_id => { kind: :property, name: "attrOwningAccountId", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :resource_share_ref => { kind: :property, name: "resourceShareRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :allow_external_principals => { kind: :property, name: "allowExternalPrincipals", is_optional: true },
    :permission_arns => { kind: :property, name: "permissionArns", is_optional: true },
    :principals => { kind: :property, name: "principals", is_optional: true },
    :resource_arns => { kind: :property, name: "resourceArns", is_optional: true },
    :resource_share_configuration => { kind: :property, name: "resourceShareConfiguration", is_optional: true },
    :sources => { kind: :property, name: "sources", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", 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.



395
396
397
398
 
# File 'ram/cfn_resource_share.rb', line 395

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:



407
408
409
410
 
# File 'ram/cfn_resource_share.rb', line 407

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:



417
418
419
420
 
# File 'ram/cfn_resource_share.rb', line 417

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:



428
429
430
431
432
 
# File 'ram/cfn_resource_share.rb', line 428

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.


485
486
487
488
489
 
# File 'ram/cfn_resource_share.rb', line 485

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.



495
496
497
498
 
# File 'ram/cfn_resource_share.rb', line 495

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.



507
508
509
510
511
 
# File 'ram/cfn_resource_share.rb', line 507

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

#allow_external_principals ⇒ Boolean, ...

Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share.

Returns:



274
275
276
 
# File 'ram/cfn_resource_share.rb', line 274

def allow_external_principals()
  jsii_get_property("allowExternalPrincipals")
end

#allow_external_principals=(value) ⇒ Object 



278
279
280
281
 
# File 'ram/cfn_resource_share.rb', line 278

def allow_external_principals=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "allowExternalPrincipals") unless value.nil?
  jsii_set_property("allowExternalPrincipals", 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:



520
521
522
523
 
# File 'ram/cfn_resource_share.rb', line 520

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:



542
543
544
545
546
547
 
# File 'ram/cfn_resource_share.rb', line 542

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 resource share.

Returns:

  • (String) 


202
203
204
 
# File 'ram/cfn_resource_share.rb', line 202

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_creation_time ⇒ String

The date and time when the resource share was created.

Returns:

  • (String) 


209
210
211
 
# File 'ram/cfn_resource_share.rb', line 209

def attr_creation_time()
  jsii_get_property("attrCreationTime")
end

#attr_feature_set ⇒ String

Indicates what features are available for this resource share. This parameter can have one of the following values:.

  • STANDARD – A resource share that supports all functionality. These resource shares are visible to all principals you share the resource share with. You can modify these resource shares in AWS RAM using the console or APIs. This resource share might have been created by AWS RAM , or it might have been CREATED_FROM_POLICY and then promoted.
  • CREATED_FROM_POLICY – The customer manually shared a resource by attaching a resource-based policy. That policy did not match any existing managed permissions, so AWS RAM created this customer managed permission automatically on the customer's behalf based on the attached policy document. This type of resource share is visible only to the AWS account that created it. You can't modify it in AWS RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy .
  • PROMOTING_TO_STANDARD – This resource share was originally CREATED_FROM_POLICY , but the customer ran the PromoteResourceShareCreatedFromPolicy and that operation is still in progress. This value changes to STANDARD when complete.

Returns:

  • (String) 


220
221
222
 
# File 'ram/cfn_resource_share.rb', line 220

def attr_feature_set()
  jsii_get_property("attrFeatureSet")
end

#attr_last_updated_time ⇒ String

The date and time when the resource share was last updated.

Returns:

  • (String) 


227
228
229
 
# File 'ram/cfn_resource_share.rb', line 227

def attr_last_updated_time()
  jsii_get_property("attrLastUpdatedTime")
end

#attr_owning_account_id ⇒ String

The ID of the AWS account that owns the resource share.

Returns:

  • (String) 


234
235
236
 
# File 'ram/cfn_resource_share.rb', line 234

def ()
  jsii_get_property("attrOwningAccountId")
end

#attr_status ⇒ String

The current status of the resource share.

Returns:

  • (String) 


241
242
243
 
# File 'ram/cfn_resource_share.rb', line 241

def attr_status()
  jsii_get_property("attrStatus")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



148
149
150
 
# File 'ram/cfn_resource_share.rb', line 148

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


153
154
155
 
# File 'ram/cfn_resource_share.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) 


551
552
553
554
 
# File 'ram/cfn_resource_share.rb', line 551

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 'ram/cfn_resource_share.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 'ram/cfn_resource_share.rb', line 165

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


110
111
112
 
# File 'ram/cfn_resource_share.rb', line 110

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



170
171
172
 
# File 'ram/cfn_resource_share.rb', line 170

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:



564
565
566
567
568
 
# File 'ram/cfn_resource_share.rb', line 564

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:



575
576
577
578
 
# File 'ram/cfn_resource_share.rb', line 575

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:



645
646
647
648
 
# File 'ram/cfn_resource_share.rb', line 645

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) 


122
123
124
 
# File 'ram/cfn_resource_share.rb', line 122

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

Specifies the name of the resource share.

Returns:

  • (String) 


262
263
264
 
# File 'ram/cfn_resource_share.rb', line 262

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



266
267
268
269
 
# File 'ram/cfn_resource_share.rb', line 266

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 'ram/cfn_resource_share.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:



586
587
588
 
# File 'ram/cfn_resource_share.rb', line 586

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:



593
594
595
 
# File 'ram/cfn_resource_share.rb', line 593

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.



386
387
388
389
 
# File 'ram/cfn_resource_share.rb', line 386

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

#permission_arns ⇒ Array<String>?

Specifies the Amazon Resource Names (ARNs) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share.

Returns:

  • (Array<String>, nil) 


286
287
288
 
# File 'ram/cfn_resource_share.rb', line 286

def permission_arns()
  jsii_get_property("permissionArns")
end

#permission_arns=(value) ⇒ Object 



290
291
292
293
 
# File 'ram/cfn_resource_share.rb', line 290

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

#principals ⇒ Array<String>?

Specifies the principals to associate with the resource share.

The possible values are:.

Returns:

  • (Array<String>, nil) 


300
301
302
 
# File 'ram/cfn_resource_share.rb', line 300

def principals()
  jsii_get_property("principals")
end

#principals=(value) ⇒ Object 



304
305
306
307
 
# File 'ram/cfn_resource_share.rb', line 304

def principals=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "principals") unless value.nil?
  jsii_set_property("principals", value)
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 'ram/cfn_resource_share.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:



604
605
606
607
 
# File 'ram/cfn_resource_share.rb', line 604

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


611
612
613
614
 
# File 'ram/cfn_resource_share.rb', line 611

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:



621
622
623
624
625
 
# File 'ram/cfn_resource_share.rb', line 621

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

#resource_arns ⇒ Array<String>?

Specifies a list of one or more ARNs of the resources to associate with the resource share.

Returns:

  • (Array<String>, nil) 


312
313
314
 
# File 'ram/cfn_resource_share.rb', line 312

def resource_arns()
  jsii_get_property("resourceArns")
end

#resource_arns=(value) ⇒ Object 



316
317
318
319
 
# File 'ram/cfn_resource_share.rb', line 316

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

#resource_share_configuration ⇒ AWSCDK::IResolvable, ...

The configuration for a resource share.

Returns:



324
325
326
 
# File 'ram/cfn_resource_share.rb', line 324

def resource_share_configuration()
  jsii_get_property("resourceShareConfiguration")
end

#resource_share_configuration=(value) ⇒ Object 



328
329
330
331
332
 
# File 'ram/cfn_resource_share.rb', line 328

def resource_share_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::RAM::CfnResourceShare::ResourceShareConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yYW0uQ2ZuUmVzb3VyY2VTaGFyZS5SZXNvdXJjZVNoYXJlQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "resourceShareConfiguration") unless value.nil?
  jsii_set_property("resourceShareConfiguration", value)
end

#resource_share_ref ⇒ AWSCDK::Interfaces::AWSRAM::ResourceShareReference

A reference to a ResourceShare resource.

Returns:



248
249
250
 
# File 'ram/cfn_resource_share.rb', line 248

def resource_share_ref()
  jsii_get_property("resourceShareRef")
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.



630
631
632
 
# File 'ram/cfn_resource_share.rb', line 630

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

#sources ⇒ Array<String>?

Specifies from which source accounts the service principal has access to the resources in this resource share.

Returns:

  • (Array<String>, nil) 


337
338
339
 
# File 'ram/cfn_resource_share.rb', line 337

def sources()
  jsii_get_property("sources")
end

#sources=(value) ⇒ Object 



341
342
343
344
 
# File 'ram/cfn_resource_share.rb', line 341

def sources=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "sources") unless value.nil?
  jsii_set_property("sources", value)
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 'ram/cfn_resource_share.rb', line 131

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



255
256
257
 
# File 'ram/cfn_resource_share.rb', line 255

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

Specifies one or more tags to attach to the resource share itself.

Returns:



349
350
351
 
# File 'ram/cfn_resource_share.rb', line 349

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



353
354
355
356
357
 
# File 'ram/cfn_resource_share.rb', line 353

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



362
363
364
 
# File 'ram/cfn_resource_share.rb', line 362

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


178
179
180
 
# File 'ram/cfn_resource_share.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 'ram/cfn_resource_share.rb', line 188

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


636
637
638
639
 
# File 'ram/cfn_resource_share.rb', line 636

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) 


375
376
377
378
379
380
 
# File 'ram/cfn_resource_share.rb', line 375

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