Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Email
  5. getConfiguration
Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-oci

oci.Email.getConfiguration

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-oci

This data source provides details about a specific Configuration resource in Oracle Cloud Infrastructure Email service.

Returns email configuration associated with the specified compartment.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testConfiguration = oci.Email.getConfiguration({
    compartmentId: compartmentId,
});
Copy
import pulumi
import pulumi_oci as oci

test_configuration = oci.Email.get_configuration(compartment_id=compartment_id)
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/email"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := email.GetConfiguration(ctx, &email.GetConfigurationArgs{
			CompartmentId: compartmentId,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testConfiguration = Oci.Email.GetConfiguration.Invoke(new()
    {
        CompartmentId = compartmentId,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Email.EmailFunctions;
import com.pulumi.oci.Email.inputs.GetConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testConfiguration = EmailFunctions.getConfiguration(GetConfigurationArgs.builder()
            .compartmentId(compartmentId)
            .build());

    }
}
Copy
variables:
  testConfiguration:
    fn::invoke:
      function: oci:Email:getConfiguration
      arguments:
        compartmentId: ${compartmentId}
Copy

Using getConfiguration

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getConfiguration(args: GetConfigurationArgs, opts?: InvokeOptions): Promise<GetConfigurationResult>
function getConfigurationOutput(args: GetConfigurationOutputArgs, opts?: InvokeOptions): Output<GetConfigurationResult>
Copy
def get_configuration(compartment_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetConfigurationResult
def get_configuration_output(compartment_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetConfigurationResult]
Copy
func GetConfiguration(ctx *Context, args *GetConfigurationArgs, opts ...InvokeOption) (*GetConfigurationResult, error)
func GetConfigurationOutput(ctx *Context, args *GetConfigurationOutputArgs, opts ...InvokeOption) GetConfigurationResultOutput
Copy

> Note: This function is named GetConfiguration in the Go SDK.

public static class GetConfiguration 
{
    public static Task<GetConfigurationResult> InvokeAsync(GetConfigurationArgs args, InvokeOptions? opts = null)
    public static Output<GetConfigurationResult> Invoke(GetConfigurationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetConfigurationResult> getConfiguration(GetConfigurationArgs args, InvokeOptions options)
public static Output<GetConfigurationResult> getConfiguration(GetConfigurationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Email/getConfiguration:getConfiguration
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CompartmentId This property is required. string
The OCID for the compartment.
CompartmentId This property is required. string
The OCID for the compartment.
compartmentId This property is required. String
The OCID for the compartment.
compartmentId This property is required. string
The OCID for the compartment.
compartment_id This property is required. str
The OCID for the compartment.
compartmentId This property is required. String
The OCID for the compartment.

getConfiguration Result

The following output properties are available:

CompartmentId string
The root compartment OCID (same as the tenancy OCID)
HttpSubmitEndpoint string
Endpoint used to submit emails via the HTTP email submission API
Id string
The provider-assigned unique ID for this managed resource.
SmtpSubmitEndpoint string
Endpoint used to submit emails via the standard SMTP submission protocol. Note that TLS 1.2 and standard SMTP authentication is required for submission.
CompartmentId string
The root compartment OCID (same as the tenancy OCID)
HttpSubmitEndpoint string
Endpoint used to submit emails via the HTTP email submission API
Id string
The provider-assigned unique ID for this managed resource.
SmtpSubmitEndpoint string
Endpoint used to submit emails via the standard SMTP submission protocol. Note that TLS 1.2 and standard SMTP authentication is required for submission.
compartmentId String
The root compartment OCID (same as the tenancy OCID)
httpSubmitEndpoint String
Endpoint used to submit emails via the HTTP email submission API
id String
The provider-assigned unique ID for this managed resource.
smtpSubmitEndpoint String
Endpoint used to submit emails via the standard SMTP submission protocol. Note that TLS 1.2 and standard SMTP authentication is required for submission.
compartmentId string
The root compartment OCID (same as the tenancy OCID)
httpSubmitEndpoint string
Endpoint used to submit emails via the HTTP email submission API
id string
The provider-assigned unique ID for this managed resource.
smtpSubmitEndpoint string
Endpoint used to submit emails via the standard SMTP submission protocol. Note that TLS 1.2 and standard SMTP authentication is required for submission.
compartment_id str
The root compartment OCID (same as the tenancy OCID)
http_submit_endpoint str
Endpoint used to submit emails via the HTTP email submission API
id str
The provider-assigned unique ID for this managed resource.
smtp_submit_endpoint str
Endpoint used to submit emails via the standard SMTP submission protocol. Note that TLS 1.2 and standard SMTP authentication is required for submission.
compartmentId String
The root compartment OCID (same as the tenancy OCID)
httpSubmitEndpoint String
Endpoint used to submit emails via the HTTP email submission API
id String
The provider-assigned unique ID for this managed resource.
smtpSubmitEndpoint String
Endpoint used to submit emails via the standard SMTP submission protocol. Note that TLS 1.2 and standard SMTP authentication is required for submission.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-oci