Class: AWSCDK::S3::CfnAccessGrantsInstanceProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
s3/cfn_access_grants_instance_props.rb

Overview

Properties for defining a CfnAccessGrantsInstance.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(identity_center_arn: nil, tags: nil) ⇒ CfnAccessGrantsInstanceProps

Returns a new instance of CfnAccessGrantsInstanceProps.

Parameters:

  • identity_center_arn (String, nil) (defaults to: nil) —

    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 (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

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



11
12
13
14
15
16
 
# File 's3/cfn_access_grants_instance_props.rb', line 11

def initialize(identity_center_arn: nil, tags: nil)
  @identity_center_arn = identity_center_arn
  Jsii::Type.check_type(@identity_center_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "identityCenterArn") unless @identity_center_arn.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#identity_center_arn ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



24
25
26
 
# File 's3/cfn_access_grants_instance_props.rb', line 24

def identity_center_arn
  @identity_center_arn
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

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.

Returns:

See Also:



31
32
33
 
# File 's3/cfn_access_grants_instance_props.rb', line 31

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



33
34
35
36
37
38
 
# File 's3/cfn_access_grants_instance_props.rb', line 33

def self.jsii_properties
  {
    :identity_center_arn => "identityCenterArn",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



40
41
42
43
44
45
46
47
 
# File 's3/cfn_access_grants_instance_props.rb', line 40

def to_jsii
  result = {}
  result.merge!({
    "identityCenterArn" => @identity_center_arn,
    "tags" => @tags,
  })
  result.compact
end