1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataFlow
  5. PrivateEndpoint
Oracle Cloud Infrastructure v2.3.0 published on Wednesday, Jul 17, 2024 by Pulumi

oci.DataFlow.PrivateEndpoint

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.3.0 published on Wednesday, Jul 17, 2024 by Pulumi

    Import

    PrivateEndpoints can be imported using the id, e.g.

    $ pulumi import oci:DataFlow/privateEndpoint:PrivateEndpoint test_private_endpoint "id"
    

    Create PrivateEndpoint Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PrivateEndpoint(name: string, args: PrivateEndpointArgs, opts?: CustomResourceOptions);
    @overload
    def PrivateEndpoint(resource_name: str,
                        args: PrivateEndpointArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def PrivateEndpoint(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        compartment_id: Optional[str] = None,
                        dns_zones: Optional[Sequence[str]] = None,
                        subnet_id: Optional[str] = None,
                        defined_tags: Optional[Mapping[str, Any]] = None,
                        description: Optional[str] = None,
                        display_name: Optional[str] = None,
                        freeform_tags: Optional[Mapping[str, Any]] = None,
                        max_host_count: Optional[int] = None,
                        nsg_ids: Optional[Sequence[str]] = None,
                        scan_details: Optional[Sequence[_dataflow.PrivateEndpointScanDetailArgs]] = None)
    func NewPrivateEndpoint(ctx *Context, name string, args PrivateEndpointArgs, opts ...ResourceOption) (*PrivateEndpoint, error)
    public PrivateEndpoint(string name, PrivateEndpointArgs args, CustomResourceOptions? opts = null)
    public PrivateEndpoint(String name, PrivateEndpointArgs args)
    public PrivateEndpoint(String name, PrivateEndpointArgs args, CustomResourceOptions options)
    
    type: oci:DataFlow:PrivateEndpoint
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args PrivateEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PrivateEndpointArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PrivateEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrivateEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrivateEndpointArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var privateEndpointResource = new Oci.DataFlow.PrivateEndpoint("privateEndpointResource", new()
    {
        CompartmentId = "string",
        DnsZones = new[]
        {
            "string",
        },
        SubnetId = "string",
        DefinedTags = 
        {
            { "string", "any" },
        },
        Description = "string",
        DisplayName = "string",
        FreeformTags = 
        {
            { "string", "any" },
        },
        MaxHostCount = 0,
        NsgIds = new[]
        {
            "string",
        },
        ScanDetails = new[]
        {
            new Oci.DataFlow.Inputs.PrivateEndpointScanDetailArgs
            {
                Fqdn = "string",
                Port = "string",
            },
        },
    });
    
    example, err := DataFlow.NewPrivateEndpoint(ctx, "privateEndpointResource", &DataFlow.PrivateEndpointArgs{
    	CompartmentId: pulumi.String("string"),
    	DnsZones: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	SubnetId: pulumi.String("string"),
    	DefinedTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	Description: pulumi.String("string"),
    	DisplayName: pulumi.String("string"),
    	FreeformTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	MaxHostCount: pulumi.Int(0),
    	NsgIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ScanDetails: dataflow.PrivateEndpointScanDetailArray{
    		&dataflow.PrivateEndpointScanDetailArgs{
    			Fqdn: pulumi.String("string"),
    			Port: pulumi.String("string"),
    		},
    	},
    })
    
    var privateEndpointResource = new PrivateEndpoint("privateEndpointResource", PrivateEndpointArgs.builder()
        .compartmentId("string")
        .dnsZones("string")
        .subnetId("string")
        .definedTags(Map.of("string", "any"))
        .description("string")
        .displayName("string")
        .freeformTags(Map.of("string", "any"))
        .maxHostCount(0)
        .nsgIds("string")
        .scanDetails(PrivateEndpointScanDetailArgs.builder()
            .fqdn("string")
            .port("string")
            .build())
        .build());
    
    private_endpoint_resource = oci.data_flow.PrivateEndpoint("privateEndpointResource",
        compartment_id="string",
        dns_zones=["string"],
        subnet_id="string",
        defined_tags={
            "string": "any",
        },
        description="string",
        display_name="string",
        freeform_tags={
            "string": "any",
        },
        max_host_count=0,
        nsg_ids=["string"],
        scan_details=[oci.data_flow.PrivateEndpointScanDetailArgs(
            fqdn="string",
            port="string",
        )])
    
    const privateEndpointResource = new oci.dataflow.PrivateEndpoint("privateEndpointResource", {
        compartmentId: "string",
        dnsZones: ["string"],
        subnetId: "string",
        definedTags: {
            string: "any",
        },
        description: "string",
        displayName: "string",
        freeformTags: {
            string: "any",
        },
        maxHostCount: 0,
        nsgIds: ["string"],
        scanDetails: [{
            fqdn: "string",
            port: "string",
        }],
    });
    
    type: oci:DataFlow:PrivateEndpoint
    properties:
        compartmentId: string
        definedTags:
            string: any
        description: string
        displayName: string
        dnsZones:
            - string
        freeformTags:
            string: any
        maxHostCount: 0
        nsgIds:
            - string
        scanDetails:
            - fqdn: string
              port: string
        subnetId: string
    

    PrivateEndpoint Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The PrivateEndpoint resource accepts the following input properties:

    CompartmentId string
    (Updatable) The OCID of a compartment.
    DnsZones List<string>
    (Updatable) An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
    SubnetId string

    The OCID of a subnet.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) A user-friendly description. Avoid entering confidential information.
    DisplayName string
    (Updatable) A user-friendly name. It does not have to be unique. Avoid entering confidential information.
    FreeformTags Dictionary<string, object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    MaxHostCount int
    (Updatable) The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
    NsgIds List<string>
    (Updatable) An array of network security group OCIDs.
    ScanDetails List<PrivateEndpointScanDetail>
    (Updatable) An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
    CompartmentId string
    (Updatable) The OCID of a compartment.
    DnsZones []string
    (Updatable) An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
    SubnetId string

    The OCID of a subnet.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) A user-friendly description. Avoid entering confidential information.
    DisplayName string
    (Updatable) A user-friendly name. It does not have to be unique. Avoid entering confidential information.
    FreeformTags map[string]interface{}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    MaxHostCount int
    (Updatable) The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
    NsgIds []string
    (Updatable) An array of network security group OCIDs.
    ScanDetails []PrivateEndpointScanDetailArgs
    (Updatable) An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
    compartmentId String
    (Updatable) The OCID of a compartment.
    dnsZones List<String>
    (Updatable) An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
    subnetId String

    The OCID of a subnet.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) A user-friendly description. Avoid entering confidential information.
    displayName String
    (Updatable) A user-friendly name. It does not have to be unique. Avoid entering confidential information.
    freeformTags Map<String,Object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    maxHostCount Integer
    (Updatable) The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
    nsgIds List<String>
    (Updatable) An array of network security group OCIDs.
    scanDetails List<PrivateEndpointScanDetail>
    (Updatable) An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
    compartmentId string
    (Updatable) The OCID of a compartment.
    dnsZones string[]
    (Updatable) An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
    subnetId string

    The OCID of a subnet.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    (Updatable) A user-friendly description. Avoid entering confidential information.
    displayName string
    (Updatable) A user-friendly name. It does not have to be unique. Avoid entering confidential information.
    freeformTags {[key: string]: any}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    maxHostCount number
    (Updatable) The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
    nsgIds string[]
    (Updatable) An array of network security group OCIDs.
    scanDetails PrivateEndpointScanDetail[]
    (Updatable) An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
    compartment_id str
    (Updatable) The OCID of a compartment.
    dns_zones Sequence[str]
    (Updatable) An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
    subnet_id str

    The OCID of a subnet.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    (Updatable) A user-friendly description. Avoid entering confidential information.
    display_name str
    (Updatable) A user-friendly name. It does not have to be unique. Avoid entering confidential information.
    freeform_tags Mapping[str, Any]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    max_host_count int
    (Updatable) The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
    nsg_ids Sequence[str]
    (Updatable) An array of network security group OCIDs.
    scan_details Sequence[dataflow.PrivateEndpointScanDetailArgs]
    (Updatable) An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
    compartmentId String
    (Updatable) The OCID of a compartment.
    dnsZones List<String>
    (Updatable) An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
    subnetId String

    The OCID of a subnet.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) A user-friendly description. Avoid entering confidential information.
    displayName String
    (Updatable) A user-friendly name. It does not have to be unique. Avoid entering confidential information.
    freeformTags Map<Any>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    maxHostCount Number
    (Updatable) The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
    nsgIds List<String>
    (Updatable) An array of network security group OCIDs.
    scanDetails List<Property Map>
    (Updatable) An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PrivateEndpoint resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    The detailed messages about the lifecycle state.
    OwnerPrincipalId string
    The OCID of the user who created the resource.
    OwnerUserName string
    The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
    State string
    The current state of this private endpoint.
    TimeCreated string
    The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    TimeUpdated string
    The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    The detailed messages about the lifecycle state.
    OwnerPrincipalId string
    The OCID of the user who created the resource.
    OwnerUserName string
    The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
    State string
    The current state of this private endpoint.
    TimeCreated string
    The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    TimeUpdated string
    The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    The detailed messages about the lifecycle state.
    ownerPrincipalId String
    The OCID of the user who created the resource.
    ownerUserName String
    The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
    state String
    The current state of this private endpoint.
    timeCreated String
    The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    timeUpdated String
    The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails string
    The detailed messages about the lifecycle state.
    ownerPrincipalId string
    The OCID of the user who created the resource.
    ownerUserName string
    The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
    state string
    The current state of this private endpoint.
    timeCreated string
    The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    timeUpdated string
    The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_details str
    The detailed messages about the lifecycle state.
    owner_principal_id str
    The OCID of the user who created the resource.
    owner_user_name str
    The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
    state str
    The current state of this private endpoint.
    time_created str
    The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    time_updated str
    The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    The detailed messages about the lifecycle state.
    ownerPrincipalId String
    The OCID of the user who created the resource.
    ownerUserName String
    The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
    state String
    The current state of this private endpoint.
    timeCreated String
    The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    timeUpdated String
    The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

    Look up Existing PrivateEndpoint Resource

    Get an existing PrivateEndpoint resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PrivateEndpointState, opts?: CustomResourceOptions): PrivateEndpoint
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, Any]] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            dns_zones: Optional[Sequence[str]] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            lifecycle_details: Optional[str] = None,
            max_host_count: Optional[int] = None,
            nsg_ids: Optional[Sequence[str]] = None,
            owner_principal_id: Optional[str] = None,
            owner_user_name: Optional[str] = None,
            scan_details: Optional[Sequence[_dataflow.PrivateEndpointScanDetailArgs]] = None,
            state: Optional[str] = None,
            subnet_id: Optional[str] = None,
            time_created: Optional[str] = None,
            time_updated: Optional[str] = None) -> PrivateEndpoint
    func GetPrivateEndpoint(ctx *Context, name string, id IDInput, state *PrivateEndpointState, opts ...ResourceOption) (*PrivateEndpoint, error)
    public static PrivateEndpoint Get(string name, Input<string> id, PrivateEndpointState? state, CustomResourceOptions? opts = null)
    public static PrivateEndpoint get(String name, Output<String> id, PrivateEndpointState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CompartmentId string
    (Updatable) The OCID of a compartment.
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) A user-friendly description. Avoid entering confidential information.
    DisplayName string
    (Updatable) A user-friendly name. It does not have to be unique. Avoid entering confidential information.
    DnsZones List<string>
    (Updatable) An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
    FreeformTags Dictionary<string, object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    LifecycleDetails string
    The detailed messages about the lifecycle state.
    MaxHostCount int
    (Updatable) The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
    NsgIds List<string>
    (Updatable) An array of network security group OCIDs.
    OwnerPrincipalId string
    The OCID of the user who created the resource.
    OwnerUserName string
    The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
    ScanDetails List<PrivateEndpointScanDetail>
    (Updatable) An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
    State string
    The current state of this private endpoint.
    SubnetId string

    The OCID of a subnet.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    TimeCreated string
    The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    TimeUpdated string
    The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    CompartmentId string
    (Updatable) The OCID of a compartment.
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) A user-friendly description. Avoid entering confidential information.
    DisplayName string
    (Updatable) A user-friendly name. It does not have to be unique. Avoid entering confidential information.
    DnsZones []string
    (Updatable) An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
    FreeformTags map[string]interface{}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    LifecycleDetails string
    The detailed messages about the lifecycle state.
    MaxHostCount int
    (Updatable) The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
    NsgIds []string
    (Updatable) An array of network security group OCIDs.
    OwnerPrincipalId string
    The OCID of the user who created the resource.
    OwnerUserName string
    The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
    ScanDetails []PrivateEndpointScanDetailArgs
    (Updatable) An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
    State string
    The current state of this private endpoint.
    SubnetId string

    The OCID of a subnet.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    TimeCreated string
    The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    TimeUpdated string
    The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    compartmentId String
    (Updatable) The OCID of a compartment.
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) A user-friendly description. Avoid entering confidential information.
    displayName String
    (Updatable) A user-friendly name. It does not have to be unique. Avoid entering confidential information.
    dnsZones List<String>
    (Updatable) An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
    freeformTags Map<String,Object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycleDetails String
    The detailed messages about the lifecycle state.
    maxHostCount Integer
    (Updatable) The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
    nsgIds List<String>
    (Updatable) An array of network security group OCIDs.
    ownerPrincipalId String
    The OCID of the user who created the resource.
    ownerUserName String
    The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
    scanDetails List<PrivateEndpointScanDetail>
    (Updatable) An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
    state String
    The current state of this private endpoint.
    subnetId String

    The OCID of a subnet.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    timeCreated String
    The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    timeUpdated String
    The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    compartmentId string
    (Updatable) The OCID of a compartment.
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    (Updatable) A user-friendly description. Avoid entering confidential information.
    displayName string
    (Updatable) A user-friendly name. It does not have to be unique. Avoid entering confidential information.
    dnsZones string[]
    (Updatable) An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
    freeformTags {[key: string]: any}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycleDetails string
    The detailed messages about the lifecycle state.
    maxHostCount number
    (Updatable) The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
    nsgIds string[]
    (Updatable) An array of network security group OCIDs.
    ownerPrincipalId string
    The OCID of the user who created the resource.
    ownerUserName string
    The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
    scanDetails PrivateEndpointScanDetail[]
    (Updatable) An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
    state string
    The current state of this private endpoint.
    subnetId string

    The OCID of a subnet.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    timeCreated string
    The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    timeUpdated string
    The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    compartment_id str
    (Updatable) The OCID of a compartment.
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    (Updatable) A user-friendly description. Avoid entering confidential information.
    display_name str
    (Updatable) A user-friendly name. It does not have to be unique. Avoid entering confidential information.
    dns_zones Sequence[str]
    (Updatable) An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
    freeform_tags Mapping[str, Any]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycle_details str
    The detailed messages about the lifecycle state.
    max_host_count int
    (Updatable) The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
    nsg_ids Sequence[str]
    (Updatable) An array of network security group OCIDs.
    owner_principal_id str
    The OCID of the user who created the resource.
    owner_user_name str
    The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
    scan_details Sequence[dataflow.PrivateEndpointScanDetailArgs]
    (Updatable) An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
    state str
    The current state of this private endpoint.
    subnet_id str

    The OCID of a subnet.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    time_created str
    The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    time_updated str
    The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    compartmentId String
    (Updatable) The OCID of a compartment.
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) A user-friendly description. Avoid entering confidential information.
    displayName String
    (Updatable) A user-friendly name. It does not have to be unique. Avoid entering confidential information.
    dnsZones List<String>
    (Updatable) An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
    freeformTags Map<Any>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycleDetails String
    The detailed messages about the lifecycle state.
    maxHostCount Number
    (Updatable) The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
    nsgIds List<String>
    (Updatable) An array of network security group OCIDs.
    ownerPrincipalId String
    The OCID of the user who created the resource.
    ownerUserName String
    The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
    scanDetails List<Property Map>
    (Updatable) An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
    state String
    The current state of this private endpoint.
    subnetId String

    The OCID of a subnet.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    timeCreated String
    The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    timeUpdated String
    The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

    Supporting Types

    PrivateEndpointScanDetail, PrivateEndpointScanDetailArgs

    Fqdn string
    (Updatable) A fully-qualified domain name (FQDN).
    Port string
    (Updatable) The port number of the FQDN
    Fqdn string
    (Updatable) A fully-qualified domain name (FQDN).
    Port string
    (Updatable) The port number of the FQDN
    fqdn String
    (Updatable) A fully-qualified domain name (FQDN).
    port String
    (Updatable) The port number of the FQDN
    fqdn string
    (Updatable) A fully-qualified domain name (FQDN).
    port string
    (Updatable) The port number of the FQDN
    fqdn str
    (Updatable) A fully-qualified domain name (FQDN).
    port str
    (Updatable) The port number of the FQDN
    fqdn String
    (Updatable) A fully-qualified domain name (FQDN).
    port String
    (Updatable) The port number of the FQDN

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.3.0 published on Wednesday, Jul 17, 2024 by Pulumi