import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the Gateway resource in Oracle Cloud Infrastructure API Gateway service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/api-gateway/latest/Gateway * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/api_gateway * * Creates a new gateway. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testGateway = new oci.apigateway.Gateway("test_gateway", { * compartmentId: compartmentId, * endpointType: gatewayEndpointType, * subnetId: testSubnet.id, * certificateId: testCertificate.id, * caBundles: [{ * type: gatewayCaBundlesType, * caBundleId: testCaBundle.id, * certificateAuthorityId: testCertificateAuthority.id, * }], * definedTags: { * "Operations.CostCenter": "42", * }, * displayName: gatewayDisplayName, * freeformTags: { * Department: "Finance", * }, * ipMode: gatewayIpMode, * ipv4addressConfiguration: { * reservedIpIds: gatewayIpv4addressConfigurationReservedIpIds, * }, * ipv6addressConfiguration: { * addresses: gatewayIpv6addressConfigurationAddresses, * subnetCidrs: gatewayIpv6addressConfigurationSubnetCidrs, * }, * locks: [{ * type: gatewayLocksType, * message: gatewayLocksMessage, * }], * networkSecurityGroupIds: gatewayNetworkSecurityGroupIds, * responseCacheDetails: { * type: gatewayResponseCacheDetailsType, * authenticationSecretId: testSecret.id, * authenticationSecretVersionNumber: gatewayResponseCacheDetailsAuthenticationSecretVersionNumber, * connectTimeoutInMs: Number(gatewayResponseCacheDetailsConnectTimeoutInMs), * isSslEnabled: gatewayResponseCacheDetailsIsSslEnabled === "true", * isSslVerifyDisabled: gatewayResponseCacheDetailsIsSslVerifyDisabled === "true", * readTimeoutInMs: Number(gatewayResponseCacheDetailsReadTimeoutInMs), * sendTimeoutInMs: Number(gatewayResponseCacheDetailsSendTimeoutInMs), * servers: [{ * host: gatewayResponseCacheDetailsServersHost, * port: Number(gatewayResponseCacheDetailsServersPort), * }], * }, * }); * ``` * * ## Import * * Gateways can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:ApiGateway/gateway:Gateway test_gateway "id" * ``` */ export declare class Gateway extends pulumi.CustomResource { /** * Get an existing Gateway resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: GatewayState, opts?: pulumi.CustomResourceOptions): Gateway; /** * Returns true if the given object is an instance of Gateway. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Gateway; /** * (Updatable) An array of CA bundles that should be used on the Gateway for TLS validation. */ readonly caBundles: pulumi.Output; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource which can be empty string. */ readonly certificateId: pulumi.Output; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the resource is created. */ readonly compartmentId: pulumi.Output; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ readonly displayName: pulumi.Output; /** * Gateway endpoint type. `PUBLIC` will have a public ip address assigned to it, while `PRIVATE` will only be accessible on a private IP address on the subnet. Example: `PUBLIC` or `PRIVATE` */ readonly endpointType: pulumi.Output; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ readonly freeformTags: pulumi.Output<{ [key: string]: string; }>; /** * The hostname for APIs deployed on the gateway. */ readonly hostname: pulumi.Output; /** * An array of IP addresses associated with the gateway. */ readonly ipAddresses: pulumi.Output; /** * Determines whether the gateway has an IPv4 or IPv6 address assigned to it, or both. `IPV4` means the gateway will only have an IPv4 address assigned to it, and `IPV6` means the gateway will only have an `IPv6` address assigned to it. `DUAL_STACK` means the gateway will have both an IPv4 and IPv6 address assigned to it. Example: `IPV4` or `IPV6` or `DUAL_STACK` */ readonly ipMode: pulumi.Output; /** * IPv4 address configuration details that should be used when creating the gateway. */ readonly ipv4addressConfiguration: pulumi.Output; /** * IPv6 address configuration details that should be used when creating the gateway. */ readonly ipv6addressConfiguration: pulumi.Output; readonly isLockOverride: pulumi.Output; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state. */ readonly lifecycleDetails: pulumi.Output; /** * Locks associated with this resource. */ readonly locks: pulumi.Output; /** * (Updatable) An array of Network Security Groups OCIDs associated with this API Gateway. */ readonly networkSecurityGroupIds: pulumi.Output; /** * (Updatable) Base Gateway response cache. */ readonly responseCacheDetails: pulumi.Output; /** * The current state of the gateway. */ readonly state: pulumi.Output; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet in which related resources are created. * * ** 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 */ readonly subnetId: pulumi.Output; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ readonly systemTags: pulumi.Output<{ [key: string]: string; }>; /** * The time this resource was created. An RFC3339 formatted datetime string. */ readonly timeCreated: pulumi.Output; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ readonly timeUpdated: pulumi.Output; /** * Create a Gateway resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: GatewayArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Gateway resources. */ export interface GatewayState { /** * (Updatable) An array of CA bundles that should be used on the Gateway for TLS validation. */ caBundles?: pulumi.Input[] | undefined>; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource which can be empty string. */ certificateId?: pulumi.Input; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the resource is created. */ compartmentId?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName?: pulumi.Input; /** * Gateway endpoint type. `PUBLIC` will have a public ip address assigned to it, while `PRIVATE` will only be accessible on a private IP address on the subnet. Example: `PUBLIC` or `PRIVATE` */ endpointType?: pulumi.Input; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The hostname for APIs deployed on the gateway. */ hostname?: pulumi.Input; /** * An array of IP addresses associated with the gateway. */ ipAddresses?: pulumi.Input[] | undefined>; /** * Determines whether the gateway has an IPv4 or IPv6 address assigned to it, or both. `IPV4` means the gateway will only have an IPv4 address assigned to it, and `IPV6` means the gateway will only have an `IPv6` address assigned to it. `DUAL_STACK` means the gateway will have both an IPv4 and IPv6 address assigned to it. Example: `IPV4` or `IPV6` or `DUAL_STACK` */ ipMode?: pulumi.Input; /** * IPv4 address configuration details that should be used when creating the gateway. */ ipv4addressConfiguration?: pulumi.Input; /** * IPv6 address configuration details that should be used when creating the gateway. */ ipv6addressConfiguration?: pulumi.Input; isLockOverride?: pulumi.Input; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state. */ lifecycleDetails?: pulumi.Input; /** * Locks associated with this resource. */ locks?: pulumi.Input[] | undefined>; /** * (Updatable) An array of Network Security Groups OCIDs associated with this API Gateway. */ networkSecurityGroupIds?: pulumi.Input[] | undefined>; /** * (Updatable) Base Gateway response cache. */ responseCacheDetails?: pulumi.Input; /** * The current state of the gateway. */ state?: pulumi.Input; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet in which related resources are created. * * ** 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 */ subnetId?: pulumi.Input; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated?: pulumi.Input; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated?: pulumi.Input; } /** * The set of arguments for constructing a Gateway resource. */ export interface GatewayArgs { /** * (Updatable) An array of CA bundles that should be used on the Gateway for TLS validation. */ caBundles?: pulumi.Input[] | undefined>; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource which can be empty string. */ certificateId?: pulumi.Input; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the resource is created. */ compartmentId: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName?: pulumi.Input; /** * Gateway endpoint type. `PUBLIC` will have a public ip address assigned to it, while `PRIVATE` will only be accessible on a private IP address on the subnet. Example: `PUBLIC` or `PRIVATE` */ endpointType: pulumi.Input; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Determines whether the gateway has an IPv4 or IPv6 address assigned to it, or both. `IPV4` means the gateway will only have an IPv4 address assigned to it, and `IPV6` means the gateway will only have an `IPv6` address assigned to it. `DUAL_STACK` means the gateway will have both an IPv4 and IPv6 address assigned to it. Example: `IPV4` or `IPV6` or `DUAL_STACK` */ ipMode?: pulumi.Input; /** * IPv4 address configuration details that should be used when creating the gateway. */ ipv4addressConfiguration?: pulumi.Input; /** * IPv6 address configuration details that should be used when creating the gateway. */ ipv6addressConfiguration?: pulumi.Input; isLockOverride?: pulumi.Input; /** * Locks associated with this resource. */ locks?: pulumi.Input[] | undefined>; /** * (Updatable) An array of Network Security Groups OCIDs associated with this API Gateway. */ networkSecurityGroupIds?: pulumi.Input[] | undefined>; /** * (Updatable) Base Gateway response cache. */ responseCacheDetails?: pulumi.Input; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet in which related resources are created. * * ** 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 */ subnetId: pulumi.Input; } //# sourceMappingURL=gateway.d.ts.map