Class: AWSCDK::OSIS::CfnPipeline::VPCOptionsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
osis/cfn_pipeline.rb

Overview

Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(subnet_ids:, security_group_ids: nil, vpc_attachment_options: nil, vpc_endpoint_management: nil) ⇒ VPCOptionsProperty

Returns a new instance of VPCOptionsProperty.

Parameters:

  • subnet_ids (Array<String>) —

    A list of subnet IDs associated with the VPC endpoint.

  • security_group_ids (Array<String>, nil) (defaults to: nil) —

    A list of security groups associated with the VPC endpoint.

  • vpc_attachment_options (AWSCDK::IResolvable, AWSCDK::OSIS::CfnPipeline::VPCAttachmentOptionsProperty, nil) (defaults to: nil) —

    Options for attaching a VPC to a pipeline.

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

    Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.



958
959
960
961
962
963
964
965
966
967
 
# File 'osis/cfn_pipeline.rb', line 958

def initialize(subnet_ids:, security_group_ids: nil, vpc_attachment_options: nil, vpc_endpoint_management: nil)
  @subnet_ids = subnet_ids
  Jsii::Type.check_type(@subnet_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "subnetIds")
  @security_group_ids = security_group_ids
  Jsii::Type.check_type(@security_group_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "securityGroupIds") unless @security_group_ids.nil?
  @vpc_attachment_options = vpc_attachment_options.is_a?(Hash) ? ::AWSCDK::OSIS::CfnPipeline::VPCAttachmentOptionsProperty.new(**vpc_attachment_options.transform_keys(&:to_sym)) : vpc_attachment_options
  Jsii::Type.check_type(@vpc_attachment_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vc2lzLkNmblBpcGVsaW5lLlZwY0F0dGFjaG1lbnRPcHRpb25zUHJvcGVydHkifV19fQ==")), "vpcAttachmentOptions") unless @vpc_attachment_options.nil?
  @vpc_endpoint_management = vpc_endpoint_management
  Jsii::Type.check_type(@vpc_endpoint_management, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vpcEndpointManagement") unless @vpc_endpoint_management.nil?
end

Instance Attribute Details

#security_group_ids ⇒ Array<String>? (readonly)

A list of security groups associated with the VPC endpoint.

Returns:

  • (Array<String>, nil)

See Also:



978
979
980
 
# File 'osis/cfn_pipeline.rb', line 978

def security_group_ids
  @security_group_ids
end

#subnet_ids ⇒ Array<String> (readonly)

A list of subnet IDs associated with the VPC endpoint.

Returns:

  • (Array<String>)

See Also:



973
974
975
 
# File 'osis/cfn_pipeline.rb', line 973

def subnet_ids
  @subnet_ids
end

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

Options for attaching a VPC to a pipeline.

Returns:

See Also:



983
984
985
 
# File 'osis/cfn_pipeline.rb', line 983

def vpc_attachment_options
  @vpc_attachment_options
end

#vpc_endpoint_management ⇒ String? (readonly)

Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.

Returns:

  • (String, nil)

See Also:



988
989
990
 
# File 'osis/cfn_pipeline.rb', line 988

def vpc_endpoint_management
  @vpc_endpoint_management
end

Class Method Details

.jsii_properties ⇒ Object 



990
991
992
993
994
995
996
997
 
# File 'osis/cfn_pipeline.rb', line 990

def self.jsii_properties
  {
    :subnet_ids => "subnetIds",
    :security_group_ids => "securityGroupIds",
    :vpc_attachment_options => "vpcAttachmentOptions",
    :vpc_endpoint_management => "vpcEndpointManagement",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



999
1000
1001
1002
1003
1004
1005
1006
1007
1008
 
# File 'osis/cfn_pipeline.rb', line 999

def to_jsii
  result = {}
  result.merge!({
    "subnetIds" => @subnet_ids,
    "securityGroupIds" => @security_group_ids,
    "vpcAttachmentOptions" => @vpc_attachment_options,
    "vpcEndpointManagement" => @vpc_endpoint_management,
  })
  result.compact
end