Package software.amazon.awscdk.services.s3

Interface CfnAccessGrantsInstanceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAccessGrantsInstanceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-27T16:51:04.639Z")
@Stability(Stable)
public interface CfnAccessGrantsInstanceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAccessGrantsInstance.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.s3.*;
 CfnAccessGrantsInstanceProps cfnAccessGrantsInstanceProps = CfnAccessGrantsInstanceProps.builder()
         .identityCenterArn("identityCenterArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantsinstance.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAccessGrantsInstanceProps.Builder	A builder for CfnAccessGrantsInstanceProps
static final class	CfnAccessGrantsInstanceProps.Jsii$Proxy	An implementation for CfnAccessGrantsInstanceProps

Method Summary

Modifier and Type	Method	Description
static CfnAccessGrantsInstanceProps.Builder	builder()
default String	getIdentityCenterArn()	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.
default List<CfnTag>	getTags()	The AWS resource tags that you are adding to the S3 Access Grants instance.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIdentityCenterArn

@Stability(Stable)
@Nullable
default String getIdentityCenterArn()

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.

An IAM Identity Center instance is your corporate identity directory that you added to the IAM Identity Center.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantsinstance.html#cfn-s3-accessgrantsinstance-identitycenterarn

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantsinstance.html#cfn-s3-accessgrantsinstance-tags

builder

@Stability(Stable)
static CfnAccessGrantsInstanceProps.Builder builder()

Returns:

a CfnAccessGrantsInstanceProps.Builder of CfnAccessGrantsInstanceProps