Class GrantWithResourceOptions

Namespace

Amazon.CDK.AWS.IAM

Assembly

Amazon.CDK.AWS.IAM.dll

Options for a grant operation.

public class GrantWithResourceOptions : IGrantWithResourceOptions, ICommonGrantOptions

Inheritance

object

GrantWithResourceOptions

Implements

IGrantWithResourceOptions

ICommonGrantOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.IAM;

            IGrantable grantable;
            IResourceWithPolicy resourceWithPolicy;

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

                // the properties below are optional
                ResourceSelfArns = new [] { "resourceSelfArns" }
            };

Remarks

ExampleMetadata: fixture=_generated

Constructors

GrantWithResourceOptions()

public GrantWithResourceOptions()

Properties

Actions

The actions to grant.

public string[] Actions { get; set; }

Property Value

string[]

Grantee

The principal to grant to.

public IGrantable Grantee { get; set; }

Property Value

IGrantable

Remarks

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

Resource

The resource with a resource policy.

public IResourceWithPolicy Resource { get; set; }

Property Value

IResourceWithPolicy

Remarks

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

ResourceArns

The resource ARNs to grant to.

public string[] ResourceArns { get; set; }

Property Value

string[]

ResourceSelfArns

When referring to the resource in a resource policy, use this as ARN.

public string[]? ResourceSelfArns { get; set; }

Property Value

string[]

Remarks

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

Default: Same as regular resource ARNs