Class: AWSCDK::S3Outposts::CfnEndpointProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
s3_outposts/cfn_endpoint_props.rb

Overview

Properties for defining a CfnEndpoint.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(outpost_id:, security_group_id:, subnet_id:, access_type: nil, customer_owned_ipv4_pool: nil, failed_reason: nil) ⇒ CfnEndpointProps

Returns a new instance of CfnEndpointProps.

Parameters:

  • outpost_id (String) —

    The ID of the Outpost.

  • security_group_id (String) —

    The ID of the security group used for the endpoint.

  • subnet_id (String) —

    The ID of the subnet used for the endpoint.

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

    The container for the type of connectivity used to access the Amazon S3 on Outposts endpoint.

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

    The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint.

  • failed_reason (AWSCDK::IResolvable, AWSCDK::S3Outposts::CfnEndpoint::FailedReasonProperty, nil) (defaults to: nil) —

    The failure reason, if any, for a create or delete endpoint operation.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 's3_outposts/cfn_endpoint_props.rb', line 15

def initialize(outpost_id:, security_group_id:, subnet_id:, access_type: nil, customer_owned_ipv4_pool: nil, failed_reason: nil)
  @outpost_id = outpost_id
  Jsii::Type.check_type(@outpost_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outpostId")
  @security_group_id = security_group_id
  Jsii::Type.check_type(@security_group_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "securityGroupId")
  @subnet_id = subnet_id
  Jsii::Type.check_type(@subnet_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "subnetId")
  @access_type = access_type
  Jsii::Type.check_type(@access_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "accessType") unless @access_type.nil?
  @customer_owned_ipv4_pool = customer_owned_ipv4_pool
  Jsii::Type.check_type(@customer_owned_ipv4_pool, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customerOwnedIpv4Pool") unless @customer_owned_ipv4_pool.nil?
  @failed_reason = failed_reason.is_a?(Hash) ? ::AWSCDK::S3Outposts::CfnEndpoint::FailedReasonProperty.new(**failed_reason.transform_keys(&:to_sym)) : failed_reason
  Jsii::Type.check_type(@failed_reason, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zM291dHBvc3RzLkNmbkVuZHBvaW50LkZhaWxlZFJlYXNvblByb3BlcnR5In1dfX0=")), "failedReason") unless @failed_reason.nil?
end

Instance Attribute Details

#access_type ⇒ String? (readonly)

Note:

Default: - "Private"

The container for the type of connectivity used to access the Amazon S3 on Outposts endpoint.

To use the Amazon VPC , choose Private . To use the endpoint with an on-premises network, choose CustomerOwnedIp . If you choose CustomerOwnedIp , you must also provide the customer-owned IP address pool (CoIP pool).

Private is the default access type value.

Returns:

  • (String, nil)

See Also:



54
55
56
 
# File 's3_outposts/cfn_endpoint_props.rb', line 54

def access_type
  @access_type
end

#customer_owned_ipv4_pool ⇒ String? (readonly)

The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint.

IP addresses are allocated from this pool for the endpoint.

Returns:

  • (String, nil)

See Also:



61
62
63
 
# File 's3_outposts/cfn_endpoint_props.rb', line 61

def customer_owned_ipv4_pool
  @customer_owned_ipv4_pool
end

#failed_reason ⇒ AWSCDK::IResolvable, ... (readonly)

The failure reason, if any, for a create or delete endpoint operation.

Returns:

See Also:



66
67
68
 
# File 's3_outposts/cfn_endpoint_props.rb', line 66

def failed_reason
  @failed_reason
end

#outpost_id ⇒ String (readonly)

The ID of the Outpost.

Returns:

  • (String)

See Also:



34
35
36
 
# File 's3_outposts/cfn_endpoint_props.rb', line 34

def outpost_id
  @outpost_id
end

#security_group_id ⇒ String (readonly)

The ID of the security group used for the endpoint.

Returns:

  • (String)

See Also:



39
40
41
 
# File 's3_outposts/cfn_endpoint_props.rb', line 39

def security_group_id
  @security_group_id
end

#subnet_id ⇒ String (readonly)

The ID of the subnet used for the endpoint.

Returns:

  • (String)

See Also:



44
45
46
 
# File 's3_outposts/cfn_endpoint_props.rb', line 44

def subnet_id
  @subnet_id
end

Class Method Details

.jsii_properties ⇒ Object 



68
69
70
71
72
73
74
75
76
77
 
# File 's3_outposts/cfn_endpoint_props.rb', line 68

def self.jsii_properties
  {
    :outpost_id => "outpostId",
    :security_group_id => "securityGroupId",
    :subnet_id => "subnetId",
    :access_type => "accessType",
    :customer_owned_ipv4_pool => "customerOwnedIpv4Pool",
    :failed_reason => "failedReason",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
 
# File 's3_outposts/cfn_endpoint_props.rb', line 79

def to_jsii
  result = {}
  result.merge!({
    "outpostId" => @outpost_id,
    "securityGroupId" => @security_group_id,
    "subnetId" => @subnet_id,
    "accessType" => @access_type,
    "customerOwnedIpv4Pool" => @customer_owned_ipv4_pool,
    "failedReason" => @failed_reason,
  })
  result.compact
end