Docs
Packagesoci.Email.Sender
Explore with Pulumi AI
This resource provides the Sender resource in Oracle Cloud Infrastructure Email service.
Creates a sender for a tenancy in a given compartment.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testSender = new oci.email.Sender("test_sender", {
compartmentId: compartmentId,
emailAddress: senderEmailAddress,
definedTags: {
"Operations.CostCenter": "42",
},
freeformTags: {
Department: "Finance",
},
});
import pulumi
import pulumi_oci as oci
test_sender = oci.email.Sender("test_sender",
compartment_id=compartment_id,
email_address=sender_email_address,
defined_tags={
"Operations.CostCenter": "42",
},
freeform_tags={
"Department": "Finance",
})
package main
import (
"github.com/pulumi/pulumi-oci/sdk/go/oci/Email"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := Email.NewSender(ctx, "test_sender", &Email.SenderArgs{
CompartmentId: pulumi.Any(compartmentId),
EmailAddress: pulumi.Any(senderEmailAddress),
DefinedTags: pulumi.Map{
"Operations.CostCenter": pulumi.Any("42"),
},
FreeformTags: pulumi.Map{
"Department": pulumi.Any("Finance"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testSender = new Oci.Email.Sender("test_sender", new()
{
CompartmentId = compartmentId,
EmailAddress = senderEmailAddress,
DefinedTags =
{
{ "Operations.CostCenter", "42" },
},
FreeformTags =
{
{ "Department", "Finance" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Email.Sender;
import com.pulumi.oci.Email.SenderArgs;
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) {
var testSender = new Sender("testSender", SenderArgs.builder()
.compartmentId(compartmentId)
.emailAddress(senderEmailAddress)
.definedTags(Map.of("Operations.CostCenter", "42"))
.freeformTags(Map.of("Department", "Finance"))
.build());
}
}
resources:
testSender:
type: oci:Email:Sender
name: test_sender
properties:
compartmentId: ${compartmentId}
emailAddress: ${senderEmailAddress}
definedTags:
Operations.CostCenter: '42'
freeformTags:
Department: Finance
Create Sender Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Sender(name: string, args: SenderArgs, opts?: CustomResourceOptions);@overload
def Sender(resource_name: str,
args: SenderArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Sender(resource_name: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
email_address: Optional[str] = None,
defined_tags: Optional[Mapping[str, Any]] = None,
freeform_tags: Optional[Mapping[str, Any]] = None)func NewSender(ctx *Context, name string, args SenderArgs, opts ...ResourceOption) (*Sender, error)public Sender(string name, SenderArgs args, CustomResourceOptions? opts = null)
public Sender(String name, SenderArgs args)
public Sender(String name, SenderArgs args, CustomResourceOptions options)
type: oci:Email:Sender
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 SenderArgs
- 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 SenderArgs
- 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 SenderArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SenderArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SenderArgs
- 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 senderResource = new Oci.Email.Sender("senderResource", new()
{
CompartmentId = "string",
EmailAddress = "string",
DefinedTags =
{
{ "string", "any" },
},
FreeformTags =
{
{ "string", "any" },
},
});
example, err := Email.NewSender(ctx, "senderResource", &Email.SenderArgs{
CompartmentId: pulumi.String("string"),
EmailAddress: pulumi.String("string"),
DefinedTags: pulumi.Map{
"string": pulumi.Any("any"),
},
FreeformTags: pulumi.Map{
"string": pulumi.Any("any"),
},
})
var senderResource = new Sender("senderResource", SenderArgs.builder()
.compartmentId("string")
.emailAddress("string")
.definedTags(Map.of("string", "any"))
.freeformTags(Map.of("string", "any"))
.build());
sender_resource = oci.email.Sender("senderResource",
compartment_id="string",
email_address="string",
defined_tags={
"string": "any",
},
freeform_tags={
"string": "any",
})
const senderResource = new oci.email.Sender("senderResource", {
compartmentId: "string",
emailAddress: "string",
definedTags: {
string: "any",
},
freeformTags: {
string: "any",
},
});
type: oci:Email:Sender
properties:
compartmentId: string
definedTags:
string: any
emailAddress: string
freeformTags:
string: any
Sender 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 Sender resource accepts the following input properties:
- Compartment
Id string - (Updatable) The OCID of the compartment that contains the sender.
- Email
Address string - The email address of the sender.
- 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"} - 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"}** 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
- Compartment
Id string - (Updatable) The OCID of the compartment that contains the sender.
- Email
Address string - The email address of the sender.
- 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"} - 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"}** 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
- compartment
Id String - (Updatable) The OCID of the compartment that contains the sender.
- email
Address String - The email address of the sender.
- 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"} - 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"}** 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
- compartment
Id string - (Updatable) The OCID of the compartment that contains the sender.
- email
Address string - The email address of the sender.
- {[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"} - {[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"}** 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
- compartment_
id str - (Updatable) The OCID of the compartment that contains the sender.
- email_
address str - The email address of the sender.
- 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"} - 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"}** 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
- compartment
Id String - (Updatable) The OCID of the compartment that contains the sender.
- email
Address String - The email address of the sender.
- 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"} - 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"}** 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
Outputs
All input properties are implicitly available as output properties. Additionally, the Sender resource produces the following output properties:
- Email
Domain stringId - The email domain used to assert responsibility for emails sent from this sender.
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Spf bool - Value of the SPF field. For more information about SPF, please see SPF Authentication.
- State string
- The current status of the approved sender.
- Dictionary<string, object>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
- Email
Domain stringId - The email domain used to assert responsibility for emails sent from this sender.
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Spf bool - Value of the SPF field. For more information about SPF, please see SPF Authentication.
- State string
- The current status of the approved sender.
- map[string]interface{}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
- email
Domain StringId - The email domain used to assert responsibility for emails sent from this sender.
- id String
- The provider-assigned unique ID for this managed resource.
- is
Spf Boolean - Value of the SPF field. For more information about SPF, please see SPF Authentication.
- state String
- The current status of the approved sender.
- Map<String,Object>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
- email
Domain stringId - The email domain used to assert responsibility for emails sent from this sender.
- id string
- The provider-assigned unique ID for this managed resource.
- is
Spf boolean - Value of the SPF field. For more information about SPF, please see SPF Authentication.
- state string
- The current status of the approved sender.
- {[key: string]: any}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created string - The date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
- email_
domain_ strid - The email domain used to assert responsibility for emails sent from this sender.
- id str
- The provider-assigned unique ID for this managed resource.
- is_
spf bool - Value of the SPF field. For more information about SPF, please see SPF Authentication.
- state str
- The current status of the approved sender.
- Mapping[str, Any]
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time_
created str - The date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
- email
Domain StringId - The email domain used to assert responsibility for emails sent from this sender.
- id String
- The provider-assigned unique ID for this managed resource.
- is
Spf Boolean - Value of the SPF field. For more information about SPF, please see SPF Authentication.
- state String
- The current status of the approved sender.
- Map<Any>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
Look up Existing Sender Resource
Get an existing Sender 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?: SenderState, opts?: CustomResourceOptions): Sender@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
defined_tags: Optional[Mapping[str, Any]] = None,
email_address: Optional[str] = None,
email_domain_id: Optional[str] = None,
freeform_tags: Optional[Mapping[str, Any]] = None,
is_spf: Optional[bool] = None,
state: Optional[str] = None,
system_tags: Optional[Mapping[str, Any]] = None,
time_created: Optional[str] = None) -> Senderfunc GetSender(ctx *Context, name string, id IDInput, state *SenderState, opts ...ResourceOption) (*Sender, error)public static Sender Get(string name, Input<string> id, SenderState? state, CustomResourceOptions? opts = null)public static Sender get(String name, Output<String> id, SenderState 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.
- Compartment
Id string - (Updatable) The OCID of the compartment that contains the sender.
- 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"} - Email
Address string - The email address of the sender.
- Email
Domain stringId - The email domain used to assert responsibility for emails sent from this sender.
- 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"}** 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
- Is
Spf bool - Value of the SPF field. For more information about SPF, please see SPF Authentication.
- State string
- The current status of the approved sender.
- Dictionary<string, object>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
- Compartment
Id string - (Updatable) The OCID of the compartment that contains the sender.
- 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"} - Email
Address string - The email address of the sender.
- Email
Domain stringId - The email domain used to assert responsibility for emails sent from this sender.
- 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"}** 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
- Is
Spf bool - Value of the SPF field. For more information about SPF, please see SPF Authentication.
- State string
- The current status of the approved sender.
- map[string]interface{}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - Time
Created string - The date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
- compartment
Id String - (Updatable) The OCID of the compartment that contains the sender.
- 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"} - email
Address String - The email address of the sender.
- email
Domain StringId - The email domain used to assert responsibility for emails sent from this sender.
- 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"}** 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
- is
Spf Boolean - Value of the SPF field. For more information about SPF, please see SPF Authentication.
- state String
- The current status of the approved sender.
- Map<String,Object>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
- compartment
Id string - (Updatable) The OCID of the compartment that contains the sender.
- {[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"} - email
Address string - The email address of the sender.
- email
Domain stringId - The email domain used to assert responsibility for emails sent from this sender.
- {[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"}** 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
- is
Spf boolean - Value of the SPF field. For more information about SPF, please see SPF Authentication.
- state string
- The current status of the approved sender.
- {[key: string]: any}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created string - The date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
- compartment_
id str - (Updatable) The OCID of the compartment that contains the sender.
- 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"} - email_
address str - The email address of the sender.
- email_
domain_ strid - The email domain used to assert responsibility for emails sent from this sender.
- 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"}** 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
- is_
spf bool - Value of the SPF field. For more information about SPF, please see SPF Authentication.
- state str
- The current status of the approved sender.
- Mapping[str, Any]
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time_
created str - The date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
- compartment
Id String - (Updatable) The OCID of the compartment that contains the sender.
- 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"} - email
Address String - The email address of the sender.
- email
Domain StringId - The email domain used to assert responsibility for emails sent from this sender.
- 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"}** 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
- is
Spf Boolean - Value of the SPF field. For more information about SPF, please see SPF Authentication.
- state String
- The current status of the approved sender.
- Map<Any>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"} - time
Created String - The date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
Import
Senders can be imported using the id, e.g.
$ pulumi import oci:Email/sender:Sender test_sender "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ociTerraform Provider.