Class: AWSCDK::ECS::AuthorizationConfig

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ecs/authorization_config.rb

Overview

The authorization configuration details for the Amazon EFS file system.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(access_point_id: nil, iam: nil) ⇒ AuthorizationConfig

Returns a new instance of AuthorizationConfig.

Parameters:

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

    The access point ID to use.

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

    Whether or not to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system.



9
10
11
12
13
14
 
# File 'ecs/authorization_config.rb', line 9

def initialize(access_point_id: nil, iam: nil)
  @access_point_id = access_point_id
  Jsii::Type.check_type(@access_point_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "accessPointId") unless @access_point_id.nil?
  @iam = iam
  Jsii::Type.check_type(@iam, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "iam") unless @iam.nil?
end

Instance Attribute Details

#access_point_id ⇒ String? (readonly)

Note:

Default: No id

The access point ID to use.

If an access point is specified, the root directory value will be relative to the directory set for the access point. If specified, transit encryption must be enabled in the EFSVolumeConfiguration.

Returns:

  • (String, nil) 


24
25
26
 
# File 'ecs/authorization_config.rb', line 24

def access_point_id
  @access_point_id
end

#iam ⇒ String? (readonly)

Note:

Default: If this parameter is omitted, the default value of DISABLED is used.

Whether or not to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system.

If enabled, transit encryption must be enabled in the EFSVolumeConfiguration.

Valid values: ENABLED | DISABLED

Returns:

  • (String, nil) 


33
34
35
 
# File 'ecs/authorization_config.rb', line 33

def iam
  @iam
end

Class Method Details

.jsii_properties ⇒ Object 



35
36
37
38
39
40
 
# File 'ecs/authorization_config.rb', line 35

def self.jsii_properties
  {
    :access_point_id => "accessPointId",
    :iam => "iam",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



42
43
44
45
46
47
48
49
 
# File 'ecs/authorization_config.rb', line 42

def to_jsii
  result = {}
  result.merge!({
    "accessPointId" => @access_point_id,
    "iam" => @iam,
  })
  result.compact
end