Struct: kms.EndpointParameters

import "../ibm-cos-sdk-go-v2/service/kms"

Overview

EndpointParameters provides the parameters that influence how endpoints are resolved.

Implemented Interfaces

types.AnalyticsFilter, v4.HTTPPresigner, s3.HTTPPresignerV4, types.MetricsFilter, s3.PresignPost, arn.S3ObjectLambdaARN, types.SelectObjectContentEventStream

Structure Field Summary

• Endpoint *string

  Override the endpoint used to send this request.

• Region *string

  The AWS region used to dispatch the request.

• UseDualStack *bool

  When true, use the dual-stack endpoint.

• UseFIPS *bool

  When true, send this request to the FIPS-compliant regional endpoint.

Method Summary

• func (p EndpointParameters) ValidateRequired() error

  ValidateRequired validates required parameters are set.

• func (p EndpointParameters) WithDefaults() EndpointParameters

  WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

Structure Field Details

Endpoint *string

Override the endpoint used to send this request

Parameter is required.

SDK::Endpoint

Region *string

The AWS region used to dispatch the request.

Parameter is required.

AWS::Region

UseDualStack *bool

When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.

Defaults to false if no value is provided.

AWS::UseDualStack

UseFIPS *bool

When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.

Defaults to false if no value is provided.

AWS::UseFIPS

Method Details

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

// File 'service/kms/endpoints.go', line 266

func (p EndpointParameters) ValidateRequired() error {
	if p.UseDualStack == nil {
		return fmt.Errorf("parameter UseDualStack is required")
	}

	if p.UseFIPS == nil {
		return fmt.Errorf("parameter UseFIPS is required")
	}

	return nil
}

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

// File 'service/kms/endpoints.go', line 280

func (p EndpointParameters) WithDefaults() EndpointParameters {
	if p.UseDualStack == nil {
		p.UseDualStack = ptr.Bool(false)
	}

	if p.UseFIPS == nil {
		p.UseFIPS = ptr.Bool(false)
	}
	return p
}