Skip to content
v2.277.0

GrantWithResourceOptions Struct ​

Options for a grant operation.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iam as iam } from 'aws-cdk-lib';

declare const conditions: any;
declare const grantable: iam.IGrantable;
declare const resourceWithPolicyV2: iam.IResourceWithPolicyV2;
const grantWithResourceOptions: iam.GrantWithResourceOptions = {
  actions: ['actions'],
  grantee: grantable,
  resource: resourceWithPolicyV2,
  resourceArns: ['resourceArns'],

  // the properties below are optional
  conditions: {
    conditionsKey: {
      conditionsKey: conditions,
    },
  },
  resourceSelfArns: ['resourceSelfArns'],
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iam as iam

# conditions: Any
# grantable: iam.IGrantable
# resource_with_policy_v2: iam.IResourceWithPolicyV2

grant_with_resource_options = iam.GrantWithResourceOptions(
    actions=["actions"],
    grantee=grantable,
    resource=resource_with_policy_v2,
    resource_arns=["resourceArns"],

    # the properties below are optional
    conditions={
        "conditions_key": {
            "conditions_key": conditions
        }
    },
    resource_self_arns=["resourceSelfArns"]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.iam.*;

Object conditions;
IGrantable grantable;
IResourceWithPolicyV2 resourceWithPolicyV2;

GrantWithResourceOptions grantWithResourceOptions = GrantWithResourceOptions.builder()
        .actions(List.of("actions"))
        .grantee(grantable)
        .resource(resourceWithPolicyV2)
        .resourceArns(List.of("resourceArns"))

        // the properties below are optional
        .conditions(Map.of(
                "conditionsKey", Map.of(
                        "conditionsKey", conditions)))
        .resourceSelfArns(List.of("resourceSelfArns"))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IAM;

var conditions;
IGrantable grantable;
IResourceWithPolicyV2 resourceWithPolicyV2;

var grantWithResourceOptions = new GrantWithResourceOptions {
    Actions = new [] { "actions" },
    Grantee = grantable,
    Resource = resourceWithPolicyV2,
    ResourceArns = new [] { "resourceArns" },

    // the properties below are optional
    Conditions = new Dictionary<string, IDictionary<string, object>> {
        { "conditionsKey", new Dictionary<string, object> {
            { "conditionsKey", conditions }
        } }
    },
    ResourceSelfArns = new [] { "resourceSelfArns" }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var conditions interface{}
var grantable IGrantable
var resourceWithPolicyV2 IResourceWithPolicyV2

grantWithResourceOptions := &GrantWithResourceOptions{
	Actions: []*string{
		jsii.String("actions"),
	},
	Grantee: grantable,
	Resource: resourceWithPolicyV2,
	ResourceArns: []*string{
		jsii.String("resourceArns"),
	},

	// the properties below are optional
	Conditions: map[string]map[string]interface{}{
		"conditionsKey": map[string]interface{}{
			"conditionsKey": conditions,
		},
	},
	ResourceSelfArns: []*string{
		jsii.String("resourceSelfArns"),
	},
}

Properties ​

actionsstring[]actionstyping.List[str]actionsList<String>Actionsstring[]Actions*[]*string required #
The actions to grant.
conditionsoptional{ [key: string]: { [key: string]: any } }conditionsoptionaltyping.Mapping[str, typing.Mapping[str, Any]]conditionsoptionalMap<String, Map<String, Object>>ConditionsoptionalIDictionary<string, IDictionary<string, object>>Conditionsoptional*map[string]*map[string]interface{} #
Any conditions to attach to the grant.

Default: No conditions

granteeIGrantablegranteeIGrantablegranteeIGrantableGranteeIGrantableGranteeIGrantable required #
The principal to grant to.

Default: if principal is undefined, no work is done.

The resource with a resource policy.

The statement will be added to the resource policy if it couldn't be added to the principal policy.

resourceArnsstring[]resource_arnstyping.List[str]resourceArnsList<String>ResourceArnsstring[]ResourceArns*[]*string required #
The resource ARNs to grant to.
resourceSelfArnsoptionalstring[]resource_self_arnsoptionaltyping.List[str]resourceSelfArnsoptionalList<String>ResourceSelfArnsoptionalstring[]ResourceSelfArnsoptional*[]*string #
When referring to the resource in a resource policy, use this as ARN.

Default: Same as regular resource ARNs

(Depending on the resource type, this needs to be '*' in a resource policy).