Class: Aws::Lambda::Types::AddPermissionRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-lambda/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ String

The action that the principal can use on the function. For example, ‘lambda:InvokeFunction` or `lambda:GetFunction`.

Returns:

  • (String) 


240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/aws-sdk-lambda/types.rb', line 240

class AddPermissionRequest < Struct.new(
  :function_name,
  :statement_id,
  :action,
  :principal,
  :source_arn,
  :source_account,
  :event_source_token,
  :qualifier,
  :revision_id,
  :principal_org_id,
  :function_url_auth_type,
  :invoked_via_function_url)
  SENSITIVE = []
  include Aws::Structure
end

#event_source_token ⇒ String

For Alexa Smart Home functions, a token that the invoker must supply.

Returns:

  • (String) 


240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/aws-sdk-lambda/types.rb', line 240

class AddPermissionRequest < Struct.new(
  :function_name,
  :statement_id,
  :action,
  :principal,
  :source_arn,
  :source_account,
  :event_source_token,
  :qualifier,
  :revision_id,
  :principal_org_id,
  :function_url_auth_type,
  :invoked_via_function_url)
  SENSITIVE = []
  include Aws::Structure
end

#function_name ⇒ String

The name or ARN of the Lambda function, version, or alias.

**Name formats**

  • **Function name** – ‘my-function` (name-only), `my-function:v1` (with alias).

  • **Function ARN** –‘arn:aws:lambda:us-west-2:123456789012:function:my-function`.

  • **Partial ARN** – ‘123456789012:function:my-function`.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

Returns:

  • (String) 


240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/aws-sdk-lambda/types.rb', line 240

class AddPermissionRequest < Struct.new(
  :function_name,
  :statement_id,
  :action,
  :principal,
  :source_arn,
  :source_account,
  :event_source_token,
  :qualifier,
  :revision_id,
  :principal_org_id,
  :function_url_auth_type,
  :invoked_via_function_url)
  SENSITIVE = []
  include Aws::Structure
end

#function_url_auth_type ⇒ String

The type of authentication that your function URL uses. Set to ‘AWS_IAM` if you want to restrict access to authenticated users only. Set to `NONE` if you want to bypass IAM authentication to create a public endpoint. For more information, see [Control access to Lambda function URLs].

[1]: docs.aws.amazon.com/lambda/latest/dg/urls-auth.html

Returns:

  • (String) 


240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/aws-sdk-lambda/types.rb', line 240

class AddPermissionRequest < Struct.new(
  :function_name,
  :statement_id,
  :action,
  :principal,
  :source_arn,
  :source_account,
  :event_source_token,
  :qualifier,
  :revision_id,
  :principal_org_id,
  :function_url_auth_type,
  :invoked_via_function_url)
  SENSITIVE = []
  include Aws::Structure
end

#invoked_via_function_url ⇒ Boolean

Restricts the ‘lambda:InvokeFunction` action to function URL calls. When specified, this option prevents the principal from invoking the function by any means other than the function URL. For more information, see [Control access to Lambda function URLs].

[1]: docs.aws.amazon.com/lambda/latest/dg/urls-auth.html

Returns:

  • (Boolean) 


240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/aws-sdk-lambda/types.rb', line 240

class AddPermissionRequest < Struct.new(
  :function_name,
  :statement_id,
  :action,
  :principal,
  :source_arn,
  :source_account,
  :event_source_token,
  :qualifier,
  :revision_id,
  :principal_org_id,
  :function_url_auth_type,
  :invoked_via_function_url)
  SENSITIVE = []
  include Aws::Structure
end

#principal ⇒ String

The Amazon Web Services service, Amazon Web Services account, IAM user, or IAM role that invokes the function. If you specify a service, use ‘SourceArn` or `SourceAccount` to limit who can invoke the function through that service.

Returns:

  • (String) 


240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/aws-sdk-lambda/types.rb', line 240

class AddPermissionRequest < Struct.new(
  :function_name,
  :statement_id,
  :action,
  :principal,
  :source_arn,
  :source_account,
  :event_source_token,
  :qualifier,
  :revision_id,
  :principal_org_id,
  :function_url_auth_type,
  :invoked_via_function_url)
  SENSITIVE = []
  include Aws::Structure
end

#principal_org_id ⇒ String

The identifier for your organization in Organizations. Use this to grant permissions to all the Amazon Web Services accounts under this organization.

Returns:

  • (String) 


240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/aws-sdk-lambda/types.rb', line 240

class AddPermissionRequest < Struct.new(
  :function_name,
  :statement_id,
  :action,
  :principal,
  :source_arn,
  :source_account,
  :event_source_token,
  :qualifier,
  :revision_id,
  :principal_org_id,
  :function_url_auth_type,
  :invoked_via_function_url)
  SENSITIVE = []
  include Aws::Structure
end

#qualifier ⇒ String

Specify a version or alias to add permissions to a published version of the function.

Returns:

  • (String) 


240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/aws-sdk-lambda/types.rb', line 240

class AddPermissionRequest < Struct.new(
  :function_name,
  :statement_id,
  :action,
  :principal,
  :source_arn,
  :source_account,
  :event_source_token,
  :qualifier,
  :revision_id,
  :principal_org_id,
  :function_url_auth_type,
  :invoked_via_function_url)
  SENSITIVE = []
  include Aws::Structure
end

#revision_id ⇒ String

Update the policy only if the revision ID matches the ID that’s specified. Use this option to avoid modifying a policy that has changed since you last read it.

Returns:

  • (String) 


240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/aws-sdk-lambda/types.rb', line 240

class AddPermissionRequest < Struct.new(
  :function_name,
  :statement_id,
  :action,
  :principal,
  :source_arn,
  :source_account,
  :event_source_token,
  :qualifier,
  :revision_id,
  :principal_org_id,
  :function_url_auth_type,
  :invoked_via_function_url)
  SENSITIVE = []
  include Aws::Structure
end

#source_account ⇒ String

For Amazon Web Services service, the ID of the Amazon Web Services account that owns the resource. Use this together with ‘SourceArn` to ensure that the specified account owns the resource. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.

Returns:

  • (String) 


240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/aws-sdk-lambda/types.rb', line 240

class AddPermissionRequest < Struct.new(
  :function_name,
  :statement_id,
  :action,
  :principal,
  :source_arn,
  :source_account,
  :event_source_token,
  :qualifier,
  :revision_id,
  :principal_org_id,
  :function_url_auth_type,
  :invoked_via_function_url)
  SENSITIVE = []
  include Aws::Structure
end

#source_arn ⇒ String

For Amazon Web Services services, the ARN of the Amazon Web Services resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.

Note that Lambda configures the comparison using the ‘StringLike` operator.

Returns:

  • (String) 


240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/aws-sdk-lambda/types.rb', line 240

class AddPermissionRequest < Struct.new(
  :function_name,
  :statement_id,
  :action,
  :principal,
  :source_arn,
  :source_account,
  :event_source_token,
  :qualifier,
  :revision_id,
  :principal_org_id,
  :function_url_auth_type,
  :invoked_via_function_url)
  SENSITIVE = []
  include Aws::Structure
end

#statement_id ⇒ String

A statement identifier that differentiates the statement from others in the same policy.

Returns:

  • (String) 


240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/aws-sdk-lambda/types.rb', line 240

class AddPermissionRequest < Struct.new(
  :function_name,
  :statement_id,
  :action,
  :principal,
  :source_arn,
  :source_account,
  :event_source_token,
  :qualifier,
  :revision_id,
  :principal_org_id,
  :function_url_auth_type,
  :invoked_via_function_url)
  SENSITIVE = []
  include Aws::Structure
end