Class: AWSCDK::S3ObjectLambda::CfnAccessPoint

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSS3Objectlambda::IAccessPointRef
Defined in:
s3_object_lambda/cfn_access_point.rb

Overview

The AWS::S3ObjectLambda::AccessPoint resource specifies an Object Lambda Access Point used to access a bucket.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnAccessPoint

Create a new AWS::S3ObjectLambda::AccessPoint.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::S3ObjectLambda::CfnAccessPointProps) —

    Resource properties.



17
18
19
20
21
22
23
 
# File 's3_object_lambda/cfn_access_point.rb', line 17

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

Class Method Details

.arn_for_access_point(resource) ⇒ String

Parameters:

Returns:

  • (String) 


82
83
84
85
 
# File 's3_object_lambda/cfn_access_point.rb', line 82

def self.arn_for_access_point(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zM29iamVjdGxhbWJkYS5JQWNjZXNzUG9pbnRSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_s3objectlambda.CfnAccessPoint", "arnForAccessPoint", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


215
216
217
 
# File 's3_object_lambda/cfn_access_point.rb', line 215

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

.from_access_point_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSS3Objectlambda::IAccessPointRef

Creates a new IAccessPointRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



93
94
95
96
97
98
 
# File 's3_object_lambda/cfn_access_point.rb', line 93

def self.from_access_point_arn(scope, id, arn)
  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(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_s3objectlambda.CfnAccessPoint", "fromAccessPointArn", [scope, id, arn])
end

.from_access_point_name(scope, id, access_point_name) ⇒ AWSCDK::Interfaces::AWSS3Objectlambda::IAccessPointRef

Creates a new IAccessPointRef from a accessPointName.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • access_point_name (String)

Returns:



106
107
108
109
110
111
 
# File 's3_object_lambda/cfn_access_point.rb', line 106

def self.from_access_point_name(scope, id, access_point_name)
  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(access_point_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "accessPointName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_s3objectlambda.CfnAccessPoint", "fromAccessPointName", [scope, id, access_point_name])
end

.is_cfn_access_point(x) ⇒ Boolean

Checks whether the given object is a CfnAccessPoint.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


117
118
119
120
 
# File 's3_object_lambda/cfn_access_point.rb', line 117

def self.is_cfn_access_point(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_s3objectlambda.CfnAccessPoint", "isCfnAccessPoint", [x])
end

.jsii_overridable_methods ⇒ Object 



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
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
 
# File 's3_object_lambda/cfn_access_point.rb', line 25

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 },
    :access_point_ref => { kind: :property, name: "accessPointRef", is_optional: false },
    :attr_alias => { kind: :property, name: "attrAlias", is_optional: false },
    :attr_alias_status => { kind: :property, name: "attrAliasStatus", is_optional: false },
    :attr_alias_value => { kind: :property, name: "attrAliasValue", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_creation_date => { kind: :property, name: "attrCreationDate", is_optional: false },
    :attr_policy_status => { kind: :property, name: "attrPolicyStatus", is_optional: false },
    :attr_policy_status_is_public => { kind: :property, name: "attrPolicyStatusIsPublic", is_optional: false },
    :attr_public_access_block_configuration => { kind: :property, name: "attrPublicAccessBlockConfiguration", is_optional: false },
    :attr_public_access_block_configuration_block_public_acls => { kind: :property, name: "attrPublicAccessBlockConfigurationBlockPublicAcls", is_optional: false },
    :attr_public_access_block_configuration_block_public_policy => { kind: :property, name: "attrPublicAccessBlockConfigurationBlockPublicPolicy", is_optional: false },
    :attr_public_access_block_configuration_ignore_public_acls => { kind: :property, name: "attrPublicAccessBlockConfigurationIgnorePublicAcls", is_optional: false },
    :attr_public_access_block_configuration_restrict_public_buckets => { kind: :property, name: "attrPublicAccessBlockConfigurationRestrictPublicBuckets", is_optional: false },
    :object_lambda_configuration => { kind: :property, name: "objectLambdaConfiguration", is_optional: false },
    :name => { kind: :property, name: "name", 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

#access_point_ref ⇒ AWSCDK::Interfaces::AWSS3Objectlambda::AccessPointReference

A reference to a AccessPoint resource.

Returns:



222
223
224
 
# File 's3_object_lambda/cfn_access_point.rb', line 222

def access_point_ref()
  jsii_get_property("accessPointRef")
end

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



367
368
369
370
 
# File 's3_object_lambda/cfn_access_point.rb', line 367

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:



379
380
381
382
 
# File 's3_object_lambda/cfn_access_point.rb', line 379

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:



389
390
391
392
 
# File 's3_object_lambda/cfn_access_point.rb', line 389

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:



400
401
402
403
404
 
# File 's3_object_lambda/cfn_access_point.rb', line 400

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.


457
458
459
460
461
 
# File 's3_object_lambda/cfn_access_point.rb', line 457

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.



467
468
469
470
 
# File 's3_object_lambda/cfn_access_point.rb', line 467

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.



479
480
481
482
483
 
# File 's3_object_lambda/cfn_access_point.rb', line 479

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:



492
493
494
495
 
# File 's3_object_lambda/cfn_access_point.rb', line 492

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:



514
515
516
517
518
519
 
# File 's3_object_lambda/cfn_access_point.rb', line 514

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_alias ⇒ AWSCDK::IResolvable

Returns:



227
228
229
 
# File 's3_object_lambda/cfn_access_point.rb', line 227

def attr_alias()
  jsii_get_property("attrAlias")
end

#attr_alias_status ⇒ String

The status of the Object Lambda Access Point alias.

Valid Values: PROVISIONING | READY .

Returns:

  • (String) 


236
237
238
 
# File 's3_object_lambda/cfn_access_point.rb', line 236

def attr_alias_status()
  jsii_get_property("attrAliasStatus")
end

#attr_alias_value ⇒ String

The alias name value of the Object Lambda Access Point.

For example: myolap-1a4n8yjrb3kda96f67zwrwiiuse1a--ol-s3 .

Returns:

  • (String) 


245
246
247
 
# File 's3_object_lambda/cfn_access_point.rb', line 245

def attr_alias_value()
  jsii_get_property("attrAliasValue")
end

#attr_arn ⇒ String

Specifies the ARN for the Object Lambda Access Point.

Returns:

  • (String) 


252
253
254
 
# File 's3_object_lambda/cfn_access_point.rb', line 252

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_creation_date ⇒ String

The date and time when the specified Object Lambda Access Point was created.

Returns:

  • (String) 


259
260
261
 
# File 's3_object_lambda/cfn_access_point.rb', line 259

def attr_creation_date()
  jsii_get_property("attrCreationDate")
end

#attr_policy_status ⇒ AWSCDK::IResolvable

Returns:



264
265
266
 
# File 's3_object_lambda/cfn_access_point.rb', line 264

def attr_policy_status()
  jsii_get_property("attrPolicyStatus")
end

#attr_policy_status_is_public ⇒ AWSCDK::IResolvable

Specifies whether the Object lambda Access Point Policy is Public or not.

Object lambda Access Points are private by default.

Returns:



273
274
275
 
# File 's3_object_lambda/cfn_access_point.rb', line 273

def attr_policy_status_is_public()
  jsii_get_property("attrPolicyStatusIsPublic")
end

#attr_public_access_block_configuration ⇒ AWSCDK::IResolvable

The Public Access Block Configuration is used to block policies that would allow public access to this Object lambda Access Point.

All public access to Object lambda Access Points are blocked by default, and any policy that would give public access to them will be also blocked. This behavior cannot be changed for Object lambda Access Points.

Returns:



282
283
284
 
# File 's3_object_lambda/cfn_access_point.rb', line 282

def attr_public_access_block_configuration()
  jsii_get_property("attrPublicAccessBlockConfiguration")
end

#attr_public_access_block_configuration_block_public_acls ⇒ AWSCDK::IResolvable

Returns:



287
288
289
 
# File 's3_object_lambda/cfn_access_point.rb', line 287

def attr_public_access_block_configuration_block_public_acls()
  jsii_get_property("attrPublicAccessBlockConfigurationBlockPublicAcls")
end

#attr_public_access_block_configuration_block_public_policy ⇒ AWSCDK::IResolvable

Returns:



292
293
294
 
# File 's3_object_lambda/cfn_access_point.rb', line 292

def attr_public_access_block_configuration_block_public_policy()
  jsii_get_property("attrPublicAccessBlockConfigurationBlockPublicPolicy")
end

#attr_public_access_block_configuration_ignore_public_acls ⇒ AWSCDK::IResolvable

Returns:



297
298
299
 
# File 's3_object_lambda/cfn_access_point.rb', line 297

def attr_public_access_block_configuration_ignore_public_acls()
  jsii_get_property("attrPublicAccessBlockConfigurationIgnorePublicAcls")
end

#attr_public_access_block_configuration_restrict_public_buckets ⇒ AWSCDK::IResolvable

Returns:



302
303
304
 
# File 's3_object_lambda/cfn_access_point.rb', line 302

def attr_public_access_block_configuration_restrict_public_buckets()
  jsii_get_property("attrPublicAccessBlockConfigurationRestrictPublicBuckets")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



168
169
170
 
# File 's3_object_lambda/cfn_access_point.rb', line 168

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


173
174
175
 
# File 's3_object_lambda/cfn_access_point.rb', line 173

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


523
524
525
526
 
# File 's3_object_lambda/cfn_access_point.rb', line 523

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


178
179
180
 
# File 's3_object_lambda/cfn_access_point.rb', line 178

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


185
186
187
 
# File 's3_object_lambda/cfn_access_point.rb', line 185

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


130
131
132
 
# File 's3_object_lambda/cfn_access_point.rb', line 130

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



190
191
192
 
# File 's3_object_lambda/cfn_access_point.rb', line 190

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:



536
537
538
539
540
 
# File 's3_object_lambda/cfn_access_point.rb', line 536

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:



547
548
549
550
 
# File 's3_object_lambda/cfn_access_point.rb', line 547

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:



617
618
619
620
 
# File 's3_object_lambda/cfn_access_point.rb', line 617

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) 


142
143
144
 
# File 's3_object_lambda/cfn_access_point.rb', line 142

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String?

The name of this access point.

Returns:

  • (String, nil) 


322
323
324
 
# File 's3_object_lambda/cfn_access_point.rb', line 322

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



326
327
328
329
 
# File 's3_object_lambda/cfn_access_point.rb', line 326

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) 


125
126
127
 
# File 's3_object_lambda/cfn_access_point.rb', line 125

def node()
  jsii_get_property("node")
end

#object_lambda_configuration ⇒ AWSCDK::IResolvable, AWSCDK::S3ObjectLambda::CfnAccessPoint::ObjectLambdaConfigurationProperty

A configuration used when creating an Object Lambda Access Point.

Returns:



309
310
311
 
# File 's3_object_lambda/cfn_access_point.rb', line 309

def object_lambda_configuration()
  jsii_get_property("objectLambdaConfiguration")
end

#object_lambda_configuration=(value) ⇒ Object 



313
314
315
316
317
 
# File 's3_object_lambda/cfn_access_point.rb', line 313

def object_lambda_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::S3ObjectLambda::CfnAccessPoint::ObjectLambdaConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zM29iamVjdGxhbWJkYS5DZm5BY2Nlc3NQb2ludC5PYmplY3RMYW1iZGFDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "objectLambdaConfiguration")
  jsii_set_property("objectLambdaConfiguration", value)
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:



558
559
560
 
# File 's3_object_lambda/cfn_access_point.rb', line 558

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:



565
566
567
 
# File 's3_object_lambda/cfn_access_point.rb', line 565

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.



358
359
360
361
 
# File 's3_object_lambda/cfn_access_point.rb', line 358

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) 


161
162
163
 
# File 's3_object_lambda/cfn_access_point.rb', line 161

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:



576
577
578
579
 
# File 's3_object_lambda/cfn_access_point.rb', line 576

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


583
584
585
586
 
# File 's3_object_lambda/cfn_access_point.rb', line 583

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:



593
594
595
596
597
 
# File 's3_object_lambda/cfn_access_point.rb', line 593

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.



602
603
604
 
# File 's3_object_lambda/cfn_access_point.rb', line 602

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:



151
152
153
 
# File 's3_object_lambda/cfn_access_point.rb', line 151

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



334
335
336
 
# File 's3_object_lambda/cfn_access_point.rb', line 334

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


198
199
200
 
# File 's3_object_lambda/cfn_access_point.rb', line 198

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


208
209
210
 
# File 's3_object_lambda/cfn_access_point.rb', line 208

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


608
609
610
611
 
# File 's3_object_lambda/cfn_access_point.rb', line 608

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) 


347
348
349
350
351
352
 
# File 's3_object_lambda/cfn_access_point.rb', line 347

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