class Amazonite::Lambda::AddPermissionRequest

Included Modules

JSON::Serializable

Defined in:

lambda/add_permission_request.cr

Constructors

.new(function_name : String, statement_id : String, action : String, principal : String, source_arn : String | Nil = nil, function_url_auth_type : FunctionUrlAuthType | Nil = nil, invoked_via_function_url : Bool | Nil = nil, source_account : String | Nil = nil, event_source_token : String | Nil = nil, qualifier : String | Nil = nil, revision_id : String | Nil = nil, principal_org_id : String | Nil = nil)
.new(pull : JSON::PullParser)
.new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance Method Summary

#==(other : self)
Returns true if this reference is the same as other.
#action : String
The action that the principal can use on the function.
#action=(action : String)
The action that the principal can use on the function.
#event_source_token : String | Nil
For Alexa Smart Home functions, a token that the invoker must supply.
#event_source_token=(event_source_token : String | Nil)
For Alexa Smart Home functions, a token that the invoker must supply.
#function_name : String
The name or ARN of the Lambda function, version, or alias.
#function_name=(function_name : String)
The name or ARN of the Lambda function, version, or alias.
#function_url_auth_type : FunctionUrlAuthType | Nil
The type of authentication that your function URL uses.
#function_url_auth_type=(function_url_auth_type : FunctionUrlAuthType | Nil)
The type of authentication that your function URL uses.
#hash(hasher)
See Object#hash(hasher)
#invoked_via_function_url : Bool | Nil
Indicates whether the permission applies when the function is invoked through a function URL.
#invoked_via_function_url=(invoked_via_function_url : Bool | Nil)
Indicates whether the permission applies when the function is invoked through a function URL.
#principal : String
The Amazon Web Services service, Amazon Web Services account, IAM user, or IAM role that invokes the function.
#principal=(principal : String)
The Amazon Web Services service, Amazon Web Services account, IAM user, or IAM role that invokes the function.
#principal_org_id : String | Nil
The identifier for your organization in Organizations.
#principal_org_id=(principal_org_id : String | Nil)
The identifier for your organization in Organizations.
#qualifier : String | Nil
Specify a version or alias to add permissions to a published version of the function.
#qualifier=(qualifier : String | Nil)
Specify a version or alias to add permissions to a published version of the function.
#revision_id : String | Nil
Update the policy only if the revision ID matches the ID that's specified.
#revision_id=(revision_id : String | Nil)
Update the policy only if the revision ID matches the ID that's specified.
#source_account : String | Nil
For Amazon Web Services service, the ID of the Amazon Web Services account that owns the resource.
#source_account=(source_account : String | Nil)
For Amazon Web Services service, the ID of the Amazon Web Services account that owns the resource.
#source_arn : String | Nil
For Amazon Web Services services, the ARN of the Amazon Web Services resource that invokes the function.
#source_arn=(source_arn : String | Nil)
For Amazon Web Services services, the ARN of the Amazon Web Services resource that invokes the function.
#statement_id : String
A statement identifier that differentiates the statement from others in the same policy.
#statement_id=(statement_id : String)
A statement identifier that differentiates the statement from others in the same policy.
#validate! : Nil

Constructor Detail

def self.new(function_name : String, statement_id : String, action : String, principal : String, source_arn : String | Nil = nil, function_url_auth_type : FunctionUrlAuthType | Nil = nil, invoked_via_function_url : Bool | Nil = nil, source_account : String | Nil = nil, event_source_token : String | Nil = nil, qualifier : String | Nil = nil, revision_id : String | Nil = nil, principal_org_id : String | Nil = nil) #

[View source]

def self.new(pull : JSON::PullParser) #

[View source]

def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #

Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.

def action : String #

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

[View source]

def action=(action : String) #

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

[View source]

def event_source_token : String | Nil #

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

[View source]

def event_source_token=(event_source_token : String | Nil) #

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

[View source]

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

[View source]

def function_name=(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.

[View source]

def function_url_auth_type : FunctionUrlAuthType | Nil #

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.

[View source]

def function_url_auth_type=(function_url_auth_type : FunctionUrlAuthType | Nil) #

[View source]

def hash(hasher) #

Description copied from class Reference

See Object#hash(hasher)

def invoked_via_function_url : Bool | Nil #

Indicates whether the permission applies when the function is invoked through a function URL.

[View source]

def invoked_via_function_url=(invoked_via_function_url : Bool | Nil) #

Indicates whether the permission applies when the function is invoked through a function URL.

[View source]

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

[View source]

def principal=(principal : String) #

[View source]

def principal_org_id : String | Nil #

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

[View source]

def principal_org_id=(principal_org_id : String | Nil) #

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

[View source]

def qualifier : String | Nil #

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

[View source]

def qualifier=(qualifier : String | Nil) #

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

[View source]

def revision_id : String | Nil #

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.

[View source]

def revision_id=(revision_id : String | Nil) #

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.

[View source]

def source_account : String | Nil #

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.

[View source]

def source_account=(source_account : String | Nil) #

[View source]

def source_arn : String | Nil #

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.

[View source]

def source_arn=(source_arn : String | Nil) #

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.

[View source]

def statement_id : String #

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

[View source]

def statement_id=(statement_id : String) #

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

[View source]

def validate! : Nil #

[View source]