Class EkmsPrivateEndpoint

EKMS private endpoint created in customer subnet used to connect to external key manager system

Inheritance

object

EkmsPrivateEndpoint

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.KeymanagementService.Models

Assembly: OCI.DotNetSDK.Keymanagement.dll

Syntax

public class EkmsPrivateEndpoint

Properties

CaBundle

Declaration

[JsonProperty(PropertyName = "caBundle")]
public string CaBundle { get; set; }

Property Value

Type	Description
string	CABundle to validate TLS certificate of the external key manager system in PEM format

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	Compartment Identifier.

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace": {"bar-key": "value"}}

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	EKMS Private Endpoint display name

Remarks

Required

ExternalKeyManagerIp

Declaration

[Required(ErrorMessage = "ExternalKeyManagerIp is required.")]
[JsonProperty(PropertyName = "externalKeyManagerIp")]
public string ExternalKeyManagerIp { get; set; }

Property Value

Type	Description
string	Private IP of the external key manager system to connect to from the EKMS private endpoint

Remarks

Required

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	Unique identifier that is immutable

Remarks

Required

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public EkmsPrivateEndpoint.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
EkmsPrivateEndpoint.LifecycleStateEnum?	The current state of the EKMS private endpoint resource.

Remarks

Required

Port

Declaration

[JsonProperty(PropertyName = "port")]
public int? Port { get; set; }

Property Value

Type	Description
int?	The port of the external key manager system

PrivateEndpointIp

Declaration

[JsonProperty(PropertyName = "privateEndpointIp")]
public string PrivateEndpointIp { get; set; }

Property Value

Type	Description
string	The IP address in the customer's VCN for the EKMS private endpoint. This is taken from subnet

SubnetId

Declaration

[Required(ErrorMessage = "SubnetId is required.")]
[JsonProperty(PropertyName = "subnetId")]
public string SubnetId { get; set; }

Property Value

Type	Description
string	Subnet Identifier

Remarks

Required

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The time the EKMS private endpoint was created. An RFC3339 formatted datetime string.

Remarks

Required

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The time the EKMS private endpoint was updated. An RFC3339 formatted datetime string.