Class CfnAccessGrantsLocation

The AWS::S3::AccessGrantsLocation resource creates the S3 data location that you would like to register in your S3 Access Grants instance.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnAccessGrantsLocation

Implements

IInspectable

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.S3

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnAccessGrantsLocation : CfnResource, IInspectable, ITaggableV2

Syntax (vb)

Public Class CfnAccessGrantsLocation Inherits CfnResource Implements IInspectable, ITaggableV2

Remarks

Your S3 data must be in the same Region as your S3 Access Grants instance. The location can be one of the following:

When you register a location, you must include the IAM role that has permission to manage the S3 location that you are registering. Give S3 Access Grants permission to assume this role using a policy . S3 Access Grants assumes this role to manage access to the location and to vend temporary credentials to grantees or client applications.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html

CloudformationResource: AWS::S3::AccessGrantsLocation

ExampleMetadata: fixture=_generated

Examples

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

             var cfnAccessGrantsLocation = new CfnAccessGrantsLocation(this, "MyCfnAccessGrantsLocation", new CfnAccessGrantsLocationProps {
                 IamRoleArn = "iamRoleArn",
                 LocationScope = "locationScope",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnAccessGrantsLocation(Construct, string, ICfnAccessGrantsLocationProps?)

The AWS::S3::AccessGrantsLocation resource creates the S3 data location that you would like to register in your S3 Access Grants instance.

Properties

AttrAccessGrantsLocationArn	The ARN of the location you are registering.
AttrAccessGrantsLocationId	The ID of the registered location to which you are granting access.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	The AWS::S3::AccessGrantsLocation resource creates the S3 data location that you would like to register in your S3 Access Grants instance.
IamRoleArn	The Amazon Resource Name (ARN) of the IAM role for the registered location.
LocationScope	The S3 URI path to the location that you are registering.
Tags	The AWS resource tags that you are adding to the S3 Access Grants location.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	The AWS::S3::AccessGrantsLocation resource creates the S3 data location that you would like to register in your S3 Access Grants instance.

Constructors

CfnAccessGrantsLocation(Construct, string, ICfnAccessGrantsLocationProps?)

The AWS::S3::AccessGrantsLocation resource creates the S3 data location that you would like to register in your S3 Access Grants instance.

public CfnAccessGrantsLocation(Construct scope, string id, ICfnAccessGrantsLocationProps? props = null)

Parameters

scope Construct

Scope in which this resource is defined.

id string

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

props ICfnAccessGrantsLocationProps

Resource properties.

Remarks

Your S3 data must be in the same Region as your S3 Access Grants instance. The location can be one of the following:

When you register a location, you must include the IAM role that has permission to manage the S3 location that you are registering. Give S3 Access Grants permission to assume this role using a policy . S3 Access Grants assumes this role to manage access to the location and to vend temporary credentials to grantees or client applications.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html

CloudformationResource: AWS::S3::AccessGrantsLocation

ExampleMetadata: fixture=_generated

Properties

AttrAccessGrantsLocationArn

The ARN of the location you are registering.

public virtual string AttrAccessGrantsLocationArn { get; }

Property Value

string

Remarks

CloudformationAttribute: AccessGrantsLocationArn

AttrAccessGrantsLocationId

The ID of the registered location to which you are granting access.

public virtual string AttrAccessGrantsLocationId { get; }

Property Value

string

Remarks

S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

CloudformationAttribute: AccessGrantsLocationId

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

Your S3 data must be in the same Region as your S3 Access Grants instance. The location can be one of the following:

When you register a location, you must include the IAM role that has permission to manage the S3 location that you are registering. Give S3 Access Grants permission to assume this role using a policy . S3 Access Grants assumes this role to manage access to the location and to vend temporary credentials to grantees or client applications.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html

CloudformationResource: AWS::S3::AccessGrantsLocation

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

Your S3 data must be in the same Region as your S3 Access Grants instance. The location can be one of the following:

When you register a location, you must include the IAM role that has permission to manage the S3 location that you are registering. Give S3 Access Grants permission to assume this role using a policy . S3 Access Grants assumes this role to manage access to the location and to vend temporary credentials to grantees or client applications.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html

CloudformationResource: AWS::S3::AccessGrantsLocation

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::S3::AccessGrantsLocation resource creates the S3 data location that you would like to register in your S3 Access Grants instance.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

Your S3 data must be in the same Region as your S3 Access Grants instance. The location can be one of the following:

When you register a location, you must include the IAM role that has permission to manage the S3 location that you are registering. Give S3 Access Grants permission to assume this role using a policy . S3 Access Grants assumes this role to manage access to the location and to vend temporary credentials to grantees or client applications.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html

CloudformationResource: AWS::S3::AccessGrantsLocation

ExampleMetadata: fixture=_generated

IamRoleArn

The Amazon Resource Name (ARN) of the IAM role for the registered location.

public virtual string? IamRoleArn { get; set; }

Property Value

string

Remarks

Your S3 data must be in the same Region as your S3 Access Grants instance. The location can be one of the following:

When you register a location, you must include the IAM role that has permission to manage the S3 location that you are registering. Give S3 Access Grants permission to assume this role using a policy . S3 Access Grants assumes this role to manage access to the location and to vend temporary credentials to grantees or client applications.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html

CloudformationResource: AWS::S3::AccessGrantsLocation

ExampleMetadata: fixture=_generated

LocationScope

The S3 URI path to the location that you are registering.

public virtual string? LocationScope { get; set; }

Property Value

string

Remarks

Your S3 data must be in the same Region as your S3 Access Grants instance. The location can be one of the following:

When you register a location, you must include the IAM role that has permission to manage the S3 location that you are registering. Give S3 Access Grants permission to assume this role using a policy . S3 Access Grants assumes this role to manage access to the location and to vend temporary credentials to grantees or client applications.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html

CloudformationResource: AWS::S3::AccessGrantsLocation

ExampleMetadata: fixture=_generated

Tags

The AWS resource tags that you are adding to the S3 Access Grants location.

public virtual ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

Your S3 data must be in the same Region as your S3 Access Grants instance. The location can be one of the following:

When you register a location, you must include the IAM role that has permission to manage the S3 location that you are registering. Give S3 Access Grants permission to assume this role using a policy . S3 Access Grants assumes this role to manage access to the location and to vend temporary credentials to grantees or client applications.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html

CloudformationResource: AWS::S3::AccessGrantsLocation

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

Your S3 data must be in the same Region as your S3 Access Grants instance. The location can be one of the following:

When you register a location, you must include the IAM role that has permission to manage the S3 location that you are registering. Give S3 Access Grants permission to assume this role using a policy . S3 Access Grants assumes this role to manage access to the location and to vend temporary credentials to grantees or client applications.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html

CloudformationResource: AWS::S3::AccessGrantsLocation

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::S3::AccessGrantsLocation resource creates the S3 data location that you would like to register in your S3 Access Grants instance.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

Your S3 data must be in the same Region as your S3 Access Grants instance. The location can be one of the following:

When you register a location, you must include the IAM role that has permission to manage the S3 location that you are registering. Give S3 Access Grants permission to assume this role using a policy . S3 Access Grants assumes this role to manage access to the location and to vend temporary credentials to grantees or client applications.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html

CloudformationResource: AWS::S3::AccessGrantsLocation

ExampleMetadata: fixture=_generated

Implements

IInspectable

ITaggableV2