Class: Aws::OpenSearchService::Types::DomainEndpointOptions

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb

Overview

Note:

When making an API call, you may pass DomainEndpointOptions data as a hash:

{
  enforce_https: false,
  tls_security_policy: "Policy-Min-TLS-1-0-2019-07", # accepts Policy-Min-TLS-1-0-2019-07, Policy-Min-TLS-1-2-2019-07
  custom_endpoint_enabled: false,
  custom_endpoint: "DomainNameFqdn",
  custom_endpoint_certificate_arn: "ARN",
}

Options to configure the endpoint for the domain.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#custom_endpointString

The fully qualified domain for your custom endpoint.

Returns:

  • (String)


2381
2382
2383
2384
2385
2386
2387
2388
2389
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 2381

class DomainEndpointOptions < Struct.new(
  :enforce_https,
  :tls_security_policy,
  :custom_endpoint_enabled,
  :custom_endpoint,
  :custom_endpoint_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#custom_endpoint_certificate_arnString

The ACM certificate ARN for your custom endpoint.

Returns:

  • (String)


2381
2382
2383
2384
2385
2386
2387
2388
2389
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 2381

class DomainEndpointOptions < Struct.new(
  :enforce_https,
  :tls_security_policy,
  :custom_endpoint_enabled,
  :custom_endpoint,
  :custom_endpoint_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#custom_endpoint_enabledBoolean

Whether to enable a custom endpoint for the domain.

Returns:

  • (Boolean)


2381
2382
2383
2384
2385
2386
2387
2388
2389
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 2381

class DomainEndpointOptions < Struct.new(
  :enforce_https,
  :tls_security_policy,
  :custom_endpoint_enabled,
  :custom_endpoint,
  :custom_endpoint_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#enforce_httpsBoolean

Whether only HTTPS endpoint should be enabled for the domain.

Returns:

  • (Boolean)


2381
2382
2383
2384
2385
2386
2387
2388
2389
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 2381

class DomainEndpointOptions < Struct.new(
  :enforce_https,
  :tls_security_policy,
  :custom_endpoint_enabled,
  :custom_endpoint,
  :custom_endpoint_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end

#tls_security_policyString

Specify the TLS security policy to apply to the HTTPS endpoint of the domain. Can be one of the following values: * Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher. * Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2

Returns:

  • (String)


2381
2382
2383
2384
2385
2386
2387
2388
2389
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 2381

class DomainEndpointOptions < Struct.new(
  :enforce_https,
  :tls_security_policy,
  :custom_endpoint_enabled,
  :custom_endpoint,
  :custom_endpoint_certificate_arn)
  SENSITIVE = []
  include Aws::Structure
end