Class CfnAccessGrantsInstance
The AWS::S3::AccessGrantInstance
resource creates an S3 Access Grants instance, which serves as a logical grouping for access grants.
Inherited Members
Namespace: Amazon.CDK.AWS.S3
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnAccessGrantsInstance : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnAccessGrantsInstance
Inherits CfnResource
Implements IInspectable, ITaggableV2
Remarks
You can create one S3 Access Grants instance per Region per account.
CloudformationResource: AWS::S3::AccessGrantsInstance
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 cfnAccessGrantsInstance = new CfnAccessGrantsInstance(this, "MyCfnAccessGrantsInstance", new CfnAccessGrantsInstanceProps {
IdentityCenterArn = "identityCenterArn",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnAccessGrantsInstance(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnAccessGrantsInstance(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnAccessGrantsInstance(Construct, String, ICfnAccessGrantsInstanceProps) |
Properties
AttrAccessGrantsInstanceArn | The ARN of the S3 Access Grants instance. |
AttrAccessGrantsInstanceId | The ID of the S3 Access Grants instance. |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
IdentityCenterArn | If you would like to associate your S3 Access Grants instance with an AWS IAM Identity Center instance, use this field to pass the Amazon Resource Name (ARN) of the AWS IAM Identity Center instance that you are associating with your S3 Access Grants instance. |
Tags | The AWS resource tags that you are adding to the S3 Access Grants instance. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnAccessGrantsInstance(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnAccessGrantsInstance(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnAccessGrantsInstance(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnAccessGrantsInstance(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnAccessGrantsInstance(Construct, String, ICfnAccessGrantsInstanceProps)
public CfnAccessGrantsInstance(Construct scope, string id, ICfnAccessGrantsInstanceProps props = null)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnAccessGrantsInstanceProps
Resource properties.
Properties
AttrAccessGrantsInstanceArn
The ARN of the S3 Access Grants instance.
public virtual string AttrAccessGrantsInstanceArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: AccessGrantsInstanceArn
AttrAccessGrantsInstanceId
The ID of the S3 Access Grants instance.
public virtual string AttrAccessGrantsInstanceId { get; }
Property Value
System.String
Remarks
The ID is default
. You can have one S3 Access Grants instance per Region per account.
CloudformationAttribute: AccessGrantsInstanceId
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
IdentityCenterArn
If you would like to associate your S3 Access Grants instance with an AWS IAM Identity Center instance, use this field to pass the Amazon Resource Name (ARN) of the AWS IAM Identity Center instance that you are associating with your S3 Access Grants instance.
public virtual string IdentityCenterArn { get; set; }
Property Value
System.String
Tags
The AWS resource tags that you are adding to the S3 Access Grants instance.
public virtual ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>