Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. customerprofiles
  5. Profile
AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-aws

aws.customerprofiles.Profile

Explore with Pulumi AI

aws logo
AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-aws

    Resource for managing an Amazon Customer Profiles Profile. See the Create Profile for more information.

    Example Usage

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

const example = new aws.customerprofiles.Domain("example", {domainName: "example"});
const exampleProfile = new aws.customerprofiles.Profile("example", {domainName: example.domainName});

    import pulumi
import pulumi_aws as aws

example = aws.customerprofiles.Domain("example", domain_name="example")
example_profile = aws.customerprofiles.Profile("example", domain_name=example.domain_name)

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/customerprofiles"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := customerprofiles.NewDomain(ctx, "example", &customerprofiles.DomainArgs{
			DomainName: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		_, err = customerprofiles.NewProfile(ctx, "example", &customerprofiles.ProfileArgs{
			DomainName: example.DomainName,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.CustomerProfiles.Domain("example", new()
    {
        DomainName = "example",
    });

    var exampleProfile = new Aws.CustomerProfiles.Profile("example", new()
    {
        DomainName = example.DomainName,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.customerprofiles.Domain;
import com.pulumi.aws.customerprofiles.DomainArgs;
import com.pulumi.aws.customerprofiles.Profile;
import com.pulumi.aws.customerprofiles.ProfileArgs;
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 example = new Domain("example", DomainArgs.builder()
            .domainName("example")
            .build());

        var exampleProfile = new Profile("exampleProfile", ProfileArgs.builder()
            .domainName(example.domainName())
            .build());

    }
}

    resources:
  example:
    type: aws:customerprofiles:Domain
    properties:
      domainName: example
  exampleProfile:
    type: aws:customerprofiles:Profile
    name: example
    properties:
      domainName: ${example.domainName}

    Create Profile Resource

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

    Constructor syntax

    new Profile(name: string, args: ProfileArgs, opts?: CustomResourceOptions);
    @overload
def Profile(resource_name: str,
            args: ProfileArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Profile(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            domain_name: Optional[str] = None,
            email_address: Optional[str] = None,
            birth_date: Optional[str] = None,
            first_name: Optional[str] = None,
            home_phone_number: Optional[str] = None,
            gender_string: Optional[str] = None,
            business_email_address: Optional[str] = None,
            business_name: Optional[str] = None,
            business_phone_number: Optional[str] = None,
            additional_information: Optional[str] = None,
            account_number: Optional[str] = None,
            attributes: Optional[Mapping[str, str]] = None,
            address: Optional[ProfileAddressArgs] = None,
            billing_address: Optional[ProfileBillingAddressArgs] = None,
            last_name: Optional[str] = None,
            mailing_address: Optional[ProfileMailingAddressArgs] = None,
            middle_name: Optional[str] = None,
            mobile_phone_number: Optional[str] = None,
            party_type_string: Optional[str] = None,
            personal_email_address: Optional[str] = None,
            phone_number: Optional[str] = None,
            shipping_address: Optional[ProfileShippingAddressArgs] = None)
    func NewProfile(ctx *Context, name string, args ProfileArgs, opts ...ResourceOption) (*Profile, error)
    public Profile(string name, ProfileArgs args, CustomResourceOptions? opts = null)
    public Profile(String name, ProfileArgs args)
public Profile(String name, ProfileArgs args, CustomResourceOptions options)

    type: aws:customerprofiles:Profile
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 ProfileArgs
    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 ProfileArgs
    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 ProfileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProfileArgs
    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 profileResource = new Aws.CustomerProfiles.Profile("profileResource", new()
{
    DomainName = "string",
    EmailAddress = "string",
    BirthDate = "string",
    FirstName = "string",
    HomePhoneNumber = "string",
    GenderString = "string",
    BusinessEmailAddress = "string",
    BusinessName = "string",
    BusinessPhoneNumber = "string",
    AdditionalInformation = "string",
    AccountNumber = "string",
    Attributes = 
    {
        { "string", "string" },
    },
    Address = new Aws.CustomerProfiles.Inputs.ProfileAddressArgs
    {
        Address1 = "string",
        Address2 = "string",
        Address3 = "string",
        Address4 = "string",
        City = "string",
        Country = "string",
        County = "string",
        PostalCode = "string",
        Province = "string",
        State = "string",
    },
    BillingAddress = new Aws.CustomerProfiles.Inputs.ProfileBillingAddressArgs
    {
        Address1 = "string",
        Address2 = "string",
        Address3 = "string",
        Address4 = "string",
        City = "string",
        Country = "string",
        County = "string",
        PostalCode = "string",
        Province = "string",
        State = "string",
    },
    LastName = "string",
    MailingAddress = new Aws.CustomerProfiles.Inputs.ProfileMailingAddressArgs
    {
        Address1 = "string",
        Address2 = "string",
        Address3 = "string",
        Address4 = "string",
        City = "string",
        Country = "string",
        County = "string",
        PostalCode = "string",
        Province = "string",
        State = "string",
    },
    MiddleName = "string",
    MobilePhoneNumber = "string",
    PartyTypeString = "string",
    PersonalEmailAddress = "string",
    PhoneNumber = "string",
    ShippingAddress = new Aws.CustomerProfiles.Inputs.ProfileShippingAddressArgs
    {
        Address1 = "string",
        Address2 = "string",
        Address3 = "string",
        Address4 = "string",
        City = "string",
        Country = "string",
        County = "string",
        PostalCode = "string",
        Province = "string",
        State = "string",
    },
});

    example, err := customerprofiles.NewProfile(ctx, "profileResource", &customerprofiles.ProfileArgs{
	DomainName:            pulumi.String("string"),
	EmailAddress:          pulumi.String("string"),
	BirthDate:             pulumi.String("string"),
	FirstName:             pulumi.String("string"),
	HomePhoneNumber:       pulumi.String("string"),
	GenderString:          pulumi.String("string"),
	BusinessEmailAddress:  pulumi.String("string"),
	BusinessName:          pulumi.String("string"),
	BusinessPhoneNumber:   pulumi.String("string"),
	AdditionalInformation: pulumi.String("string"),
	AccountNumber:         pulumi.String("string"),
	Attributes: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Address: &customerprofiles.ProfileAddressArgs{
		Address1:   pulumi.String("string"),
		Address2:   pulumi.String("string"),
		Address3:   pulumi.String("string"),
		Address4:   pulumi.String("string"),
		City:       pulumi.String("string"),
		Country:    pulumi.String("string"),
		County:     pulumi.String("string"),
		PostalCode: pulumi.String("string"),
		Province:   pulumi.String("string"),
		State:      pulumi.String("string"),
	},
	BillingAddress: &customerprofiles.ProfileBillingAddressArgs{
		Address1:   pulumi.String("string"),
		Address2:   pulumi.String("string"),
		Address3:   pulumi.String("string"),
		Address4:   pulumi.String("string"),
		City:       pulumi.String("string"),
		Country:    pulumi.String("string"),
		County:     pulumi.String("string"),
		PostalCode: pulumi.String("string"),
		Province:   pulumi.String("string"),
		State:      pulumi.String("string"),
	},
	LastName: pulumi.String("string"),
	MailingAddress: &customerprofiles.ProfileMailingAddressArgs{
		Address1:   pulumi.String("string"),
		Address2:   pulumi.String("string"),
		Address3:   pulumi.String("string"),
		Address4:   pulumi.String("string"),
		City:       pulumi.String("string"),
		Country:    pulumi.String("string"),
		County:     pulumi.String("string"),
		PostalCode: pulumi.String("string"),
		Province:   pulumi.String("string"),
		State:      pulumi.String("string"),
	},
	MiddleName:           pulumi.String("string"),
	MobilePhoneNumber:    pulumi.String("string"),
	PartyTypeString:      pulumi.String("string"),
	PersonalEmailAddress: pulumi.String("string"),
	PhoneNumber:          pulumi.String("string"),
	ShippingAddress: &customerprofiles.ProfileShippingAddressArgs{
		Address1:   pulumi.String("string"),
		Address2:   pulumi.String("string"),
		Address3:   pulumi.String("string"),
		Address4:   pulumi.String("string"),
		City:       pulumi.String("string"),
		Country:    pulumi.String("string"),
		County:     pulumi.String("string"),
		PostalCode: pulumi.String("string"),
		Province:   pulumi.String("string"),
		State:      pulumi.String("string"),
	},
})

    var profileResource = new Profile("profileResource", ProfileArgs.builder()
    .domainName("string")
    .emailAddress("string")
    .birthDate("string")
    .firstName("string")
    .homePhoneNumber("string")
    .genderString("string")
    .businessEmailAddress("string")
    .businessName("string")
    .businessPhoneNumber("string")
    .additionalInformation("string")
    .accountNumber("string")
    .attributes(Map.of("string", "string"))
    .address(ProfileAddressArgs.builder()
        .address1("string")
        .address2("string")
        .address3("string")
        .address4("string")
        .city("string")
        .country("string")
        .county("string")
        .postalCode("string")
        .province("string")
        .state("string")
        .build())
    .billingAddress(ProfileBillingAddressArgs.builder()
        .address1("string")
        .address2("string")
        .address3("string")
        .address4("string")
        .city("string")
        .country("string")
        .county("string")
        .postalCode("string")
        .province("string")
        .state("string")
        .build())
    .lastName("string")
    .mailingAddress(ProfileMailingAddressArgs.builder()
        .address1("string")
        .address2("string")
        .address3("string")
        .address4("string")
        .city("string")
        .country("string")
        .county("string")
        .postalCode("string")
        .province("string")
        .state("string")
        .build())
    .middleName("string")
    .mobilePhoneNumber("string")
    .partyTypeString("string")
    .personalEmailAddress("string")
    .phoneNumber("string")
    .shippingAddress(ProfileShippingAddressArgs.builder()
        .address1("string")
        .address2("string")
        .address3("string")
        .address4("string")
        .city("string")
        .country("string")
        .county("string")
        .postalCode("string")
        .province("string")
        .state("string")
        .build())
    .build());

    profile_resource = aws.customerprofiles.Profile("profileResource",
    domain_name="string",
    email_address="string",
    birth_date="string",
    first_name="string",
    home_phone_number="string",
    gender_string="string",
    business_email_address="string",
    business_name="string",
    business_phone_number="string",
    additional_information="string",
    account_number="string",
    attributes={
        "string": "string",
    },
    address={
        "address1": "string",
        "address2": "string",
        "address3": "string",
        "address4": "string",
        "city": "string",
        "country": "string",
        "county": "string",
        "postal_code": "string",
        "province": "string",
        "state": "string",
    },
    billing_address={
        "address1": "string",
        "address2": "string",
        "address3": "string",
        "address4": "string",
        "city": "string",
        "country": "string",
        "county": "string",
        "postal_code": "string",
        "province": "string",
        "state": "string",
    },
    last_name="string",
    mailing_address={
        "address1": "string",
        "address2": "string",
        "address3": "string",
        "address4": "string",
        "city": "string",
        "country": "string",
        "county": "string",
        "postal_code": "string",
        "province": "string",
        "state": "string",
    },
    middle_name="string",
    mobile_phone_number="string",
    party_type_string="string",
    personal_email_address="string",
    phone_number="string",
    shipping_address={
        "address1": "string",
        "address2": "string",
        "address3": "string",
        "address4": "string",
        "city": "string",
        "country": "string",
        "county": "string",
        "postal_code": "string",
        "province": "string",
        "state": "string",
    })

    const profileResource = new aws.customerprofiles.Profile("profileResource", {
    domainName: "string",
    emailAddress: "string",
    birthDate: "string",
    firstName: "string",
    homePhoneNumber: "string",
    genderString: "string",
    businessEmailAddress: "string",
    businessName: "string",
    businessPhoneNumber: "string",
    additionalInformation: "string",
    accountNumber: "string",
    attributes: {
        string: "string",
    },
    address: {
        address1: "string",
        address2: "string",
        address3: "string",
        address4: "string",
        city: "string",
        country: "string",
        county: "string",
        postalCode: "string",
        province: "string",
        state: "string",
    },
    billingAddress: {
        address1: "string",
        address2: "string",
        address3: "string",
        address4: "string",
        city: "string",
        country: "string",
        county: "string",
        postalCode: "string",
        province: "string",
        state: "string",
    },
    lastName: "string",
    mailingAddress: {
        address1: "string",
        address2: "string",
        address3: "string",
        address4: "string",
        city: "string",
        country: "string",
        county: "string",
        postalCode: "string",
        province: "string",
        state: "string",
    },
    middleName: "string",
    mobilePhoneNumber: "string",
    partyTypeString: "string",
    personalEmailAddress: "string",
    phoneNumber: "string",
    shippingAddress: {
        address1: "string",
        address2: "string",
        address3: "string",
        address4: "string",
        city: "string",
        country: "string",
        county: "string",
        postalCode: "string",
        province: "string",
        state: "string",
    },
});

    type: aws:customerprofiles:Profile
properties:
    accountNumber: string
    additionalInformation: string
    address:
        address1: string
        address2: string
        address3: string
        address4: string
        city: string
        country: string
        county: string
        postalCode: string
        province: string
        state: string
    attributes:
        string: string
    billingAddress:
        address1: string
        address2: string
        address3: string
        address4: string
        city: string
        country: string
        county: string
        postalCode: string
        province: string
        state: string
    birthDate: string
    businessEmailAddress: string
    businessName: string
    businessPhoneNumber: string
    domainName: string
    emailAddress: string
    firstName: string
    genderString: string
    homePhoneNumber: string
    lastName: string
    mailingAddress:
        address1: string
        address2: string
        address3: string
        address4: string
        city: string
        country: string
        county: string
        postalCode: string
        province: string
        state: string
    middleName: string
    mobilePhoneNumber: string
    partyTypeString: string
    personalEmailAddress: string
    phoneNumber: string
    shippingAddress:
        address1: string
        address2: string
        address3: string
        address4: string
        city: string
        country: string
        county: string
        postalCode: string
        province: string
        state: string

    Profile Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Profile resource accepts the following input properties:

    DomainName string

    The name of your Customer Profile domain. It must be unique for your AWS account.

    The following arguments are optional:

    AccountNumber string
    A unique account number that you have given to the customer.
    AdditionalInformation string
    Any additional information relevant to the customer’s profile.
    Address ProfileAddress
    A block that specifies a generic address associated with the customer that is not mailing, shipping, or billing. Documented below.
    Attributes Dictionary<string, string>
    A key value pair of attributes of a customer profile.
    BillingAddress ProfileBillingAddress
    A block that specifies the customer’s billing address. Documented below.
    BirthDate string
    The customer’s birth date.
    BusinessEmailAddress string
    The customer’s business email address.
    BusinessName string
    The name of the customer’s business.
    BusinessPhoneNumber string
    The customer’s business phone number.
    EmailAddress string
    The customer’s email address, which has not been specified as a personal or business address.
    FirstName string
    The customer’s first name.
    GenderString string
    The gender with which the customer identifies.
    HomePhoneNumber string
    The customer’s home phone number.
    LastName string
    The customer’s last name.
    MailingAddress ProfileMailingAddress
    A block that specifies the customer’s mailing address. Documented below.
    MiddleName string
    The customer’s middle name.
    MobilePhoneNumber string
    The customer’s mobile phone number.
    PartyTypeString string
    The type of profile used to describe the customer.
    PersonalEmailAddress string
    The customer’s personal email address.
    PhoneNumber string
    The customer’s phone number, which has not been specified as a mobile, home, or business number.
    ShippingAddress ProfileShippingAddress
    A block that specifies the customer’s shipping address. Documented below.
    DomainName string

    The name of your Customer Profile domain. It must be unique for your AWS account.

    The following arguments are optional:

    AccountNumber string
    A unique account number that you have given to the customer.
    AdditionalInformation string
    Any additional information relevant to the customer’s profile.
    Address ProfileAddressArgs
    A block that specifies a generic address associated with the customer that is not mailing, shipping, or billing. Documented below.
    Attributes map[string]string
    A key value pair of attributes of a customer profile.
    BillingAddress ProfileBillingAddressArgs
    A block that specifies the customer’s billing address. Documented below.
    BirthDate string
    The customer’s birth date.
    BusinessEmailAddress string
    The customer’s business email address.
    BusinessName string
    The name of the customer’s business.
    BusinessPhoneNumber string
    The customer’s business phone number.
    EmailAddress string
    The customer’s email address, which has not been specified as a personal or business address.
    FirstName string
    The customer’s first name.
    GenderString string
    The gender with which the customer identifies.
    HomePhoneNumber string
    The customer’s home phone number.
    LastName string
    The customer’s last name.
    MailingAddress ProfileMailingAddressArgs
    A block that specifies the customer’s mailing address. Documented below.
    MiddleName string
    The customer’s middle name.
    MobilePhoneNumber string
    The customer’s mobile phone number.
    PartyTypeString string
    The type of profile used to describe the customer.
    PersonalEmailAddress string
    The customer’s personal email address.
    PhoneNumber string
    The customer’s phone number, which has not been specified as a mobile, home, or business number.
    ShippingAddress ProfileShippingAddressArgs
    A block that specifies the customer’s shipping address. Documented below.
    domainName String

    The name of your Customer Profile domain. It must be unique for your AWS account.

    The following arguments are optional:

    accountNumber String
    A unique account number that you have given to the customer.
    additionalInformation String
    Any additional information relevant to the customer’s profile.
    address ProfileAddress
    A block that specifies a generic address associated with the customer that is not mailing, shipping, or billing. Documented below.
    attributes Map<String,String>
    A key value pair of attributes of a customer profile.
    billingAddress ProfileBillingAddress
    A block that specifies the customer’s billing address. Documented below.
    birthDate String
    The customer’s birth date.
    businessEmailAddress String
    The customer’s business email address.
    businessName String
    The name of the customer’s business.
    businessPhoneNumber String
    The customer’s business phone number.
    emailAddress String
    The customer’s email address, which has not been specified as a personal or business address.
    firstName String
    The customer’s first name.
    genderString String
    The gender with which the customer identifies.
    homePhoneNumber String
    The customer’s home phone number.
    lastName String
    The customer’s last name.
    mailingAddress ProfileMailingAddress
    A block that specifies the customer’s mailing address. Documented below.
    middleName String
    The customer’s middle name.
    mobilePhoneNumber String
    The customer’s mobile phone number.
    partyTypeString String
    The type of profile used to describe the customer.
    personalEmailAddress String
    The customer’s personal email address.
    phoneNumber String
    The customer’s phone number, which has not been specified as a mobile, home, or business number.
    shippingAddress ProfileShippingAddress
    A block that specifies the customer’s shipping address. Documented below.
    domainName string

    The name of your Customer Profile domain. It must be unique for your AWS account.

    The following arguments are optional:

    accountNumber string
    A unique account number that you have given to the customer.
    additionalInformation string
    Any additional information relevant to the customer’s profile.
    address ProfileAddress
    A block that specifies a generic address associated with the customer that is not mailing, shipping, or billing. Documented below.
    attributes {[key: string]: string}
    A key value pair of attributes of a customer profile.
    billingAddress ProfileBillingAddress
    A block that specifies the customer’s billing address. Documented below.
    birthDate string
    The customer’s birth date.
    businessEmailAddress string
    The customer’s business email address.
    businessName string
    The name of the customer’s business.
    businessPhoneNumber string
    The customer’s business phone number.
    emailAddress string
    The customer’s email address, which has not been specified as a personal or business address.
    firstName string
    The customer’s first name.
    genderString string
    The gender with which the customer identifies.
    homePhoneNumber string
    The customer’s home phone number.
    lastName string
    The customer’s last name.
    mailingAddress ProfileMailingAddress
    A block that specifies the customer’s mailing address. Documented below.
    middleName string
    The customer’s middle name.
    mobilePhoneNumber string
    The customer’s mobile phone number.
    partyTypeString string
    The type of profile used to describe the customer.
    personalEmailAddress string
    The customer’s personal email address.
    phoneNumber string
    The customer’s phone number, which has not been specified as a mobile, home, or business number.
    shippingAddress ProfileShippingAddress
    A block that specifies the customer’s shipping address. Documented below.
    domain_name str

    The name of your Customer Profile domain. It must be unique for your AWS account.

    The following arguments are optional:

    account_number str
    A unique account number that you have given to the customer.
    additional_information str
    Any additional information relevant to the customer’s profile.
    address ProfileAddressArgs
    A block that specifies a generic address associated with the customer that is not mailing, shipping, or billing. Documented below.
    attributes Mapping[str, str]
    A key value pair of attributes of a customer profile.
    billing_address ProfileBillingAddressArgs
    A block that specifies the customer’s billing address. Documented below.
    birth_date str
    The customer’s birth date.
    business_email_address str
    The customer’s business email address.
    business_name str
    The name of the customer’s business.
    business_phone_number str
    The customer’s business phone number.
    email_address str
    The customer’s email address, which has not been specified as a personal or business address.
    first_name str
    The customer’s first name.
    gender_string str
    The gender with which the customer identifies.
    home_phone_number str
    The customer’s home phone number.
    last_name str
    The customer’s last name.
    mailing_address ProfileMailingAddressArgs
    A block that specifies the customer’s mailing address. Documented below.
    middle_name str
    The customer’s middle name.
    mobile_phone_number str
    The customer’s mobile phone number.
    party_type_string str
    The type of profile used to describe the customer.
    personal_email_address str
    The customer’s personal email address.
    phone_number str
    The customer’s phone number, which has not been specified as a mobile, home, or business number.
    shipping_address ProfileShippingAddressArgs
    A block that specifies the customer’s shipping address. Documented below.
    domainName String

    The name of your Customer Profile domain. It must be unique for your AWS account.

    The following arguments are optional:

    accountNumber String
    A unique account number that you have given to the customer.
    additionalInformation String
    Any additional information relevant to the customer’s profile.
    address Property Map
    A block that specifies a generic address associated with the customer that is not mailing, shipping, or billing. Documented below.
    attributes Map<String>
    A key value pair of attributes of a customer profile.
    billingAddress Property Map
    A block that specifies the customer’s billing address. Documented below.
    birthDate String
    The customer’s birth date.
    businessEmailAddress String
    The customer’s business email address.
    businessName String
    The name of the customer’s business.
    businessPhoneNumber String
    The customer’s business phone number.
    emailAddress String
    The customer’s email address, which has not been specified as a personal or business address.
    firstName String
    The customer’s first name.
    genderString String
    The gender with which the customer identifies.
    homePhoneNumber String
    The customer’s home phone number.
    lastName String
    The customer’s last name.
    mailingAddress Property Map
    A block that specifies the customer’s mailing address. Documented below.
    middleName String
    The customer’s middle name.
    mobilePhoneNumber String
    The customer’s mobile phone number.
    partyTypeString String
    The type of profile used to describe the customer.
    personalEmailAddress String
    The customer’s personal email address.
    phoneNumber String
    The customer’s phone number, which has not been specified as a mobile, home, or business number.
    shippingAddress Property Map
    A block that specifies the customer’s shipping address. Documented below.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Profile Resource

    Get an existing Profile 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?: ProfileState, opts?: CustomResourceOptions): Profile
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_number: Optional[str] = None,
        additional_information: Optional[str] = None,
        address: Optional[ProfileAddressArgs] = None,
        attributes: Optional[Mapping[str, str]] = None,
        billing_address: Optional[ProfileBillingAddressArgs] = None,
        birth_date: Optional[str] = None,
        business_email_address: Optional[str] = None,
        business_name: Optional[str] = None,
        business_phone_number: Optional[str] = None,
        domain_name: Optional[str] = None,
        email_address: Optional[str] = None,
        first_name: Optional[str] = None,
        gender_string: Optional[str] = None,
        home_phone_number: Optional[str] = None,
        last_name: Optional[str] = None,
        mailing_address: Optional[ProfileMailingAddressArgs] = None,
        middle_name: Optional[str] = None,
        mobile_phone_number: Optional[str] = None,
        party_type_string: Optional[str] = None,
        personal_email_address: Optional[str] = None,
        phone_number: Optional[str] = None,
        shipping_address: Optional[ProfileShippingAddressArgs] = None) -> Profile
    func GetProfile(ctx *Context, name string, id IDInput, state *ProfileState, opts ...ResourceOption) (*Profile, error)
    public static Profile Get(string name, Input<string> id, ProfileState? state, CustomResourceOptions? opts = null)
    public static Profile get(String name, Output<String> id, ProfileState state, CustomResourceOptions options)
    resources:  _:    type: aws:customerprofiles:Profile    get:      id: ${id}
    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:
    AccountNumber string
    A unique account number that you have given to the customer.
    AdditionalInformation string
    Any additional information relevant to the customer’s profile.
    Address ProfileAddress
    A block that specifies a generic address associated with the customer that is not mailing, shipping, or billing. Documented below.
    Attributes Dictionary<string, string>
    A key value pair of attributes of a customer profile.
    BillingAddress ProfileBillingAddress
    A block that specifies the customer’s billing address. Documented below.
    BirthDate string
    The customer’s birth date.
    BusinessEmailAddress string
    The customer’s business email address.
    BusinessName string
    The name of the customer’s business.
    BusinessPhoneNumber string
    The customer’s business phone number.
    DomainName string

    The name of your Customer Profile domain. It must be unique for your AWS account.

    The following arguments are optional:

    EmailAddress string
    The customer’s email address, which has not been specified as a personal or business address.
    FirstName string
    The customer’s first name.
    GenderString string
    The gender with which the customer identifies.
    HomePhoneNumber string
    The customer’s home phone number.
    LastName string
    The customer’s last name.
    MailingAddress ProfileMailingAddress
    A block that specifies the customer’s mailing address. Documented below.
    MiddleName string
    The customer’s middle name.
    MobilePhoneNumber string
    The customer’s mobile phone number.
    PartyTypeString string
    The type of profile used to describe the customer.
    PersonalEmailAddress string
    The customer’s personal email address.
    PhoneNumber string
    The customer’s phone number, which has not been specified as a mobile, home, or business number.
    ShippingAddress ProfileShippingAddress
    A block that specifies the customer’s shipping address. Documented below.
    AccountNumber string
    A unique account number that you have given to the customer.
    AdditionalInformation string
    Any additional information relevant to the customer’s profile.
    Address ProfileAddressArgs
    A block that specifies a generic address associated with the customer that is not mailing, shipping, or billing. Documented below.
    Attributes map[string]string
    A key value pair of attributes of a customer profile.
    BillingAddress ProfileBillingAddressArgs
    A block that specifies the customer’s billing address. Documented below.
    BirthDate string
    The customer’s birth date.
    BusinessEmailAddress string
    The customer’s business email address.
    BusinessName string
    The name of the customer’s business.
    BusinessPhoneNumber string
    The customer’s business phone number.
    DomainName string

    The name of your Customer Profile domain. It must be unique for your AWS account.

    The following arguments are optional:

    EmailAddress string
    The customer’s email address, which has not been specified as a personal or business address.
    FirstName string
    The customer’s first name.
    GenderString string
    The gender with which the customer identifies.
    HomePhoneNumber string
    The customer’s home phone number.
    LastName string
    The customer’s last name.
    MailingAddress ProfileMailingAddressArgs
    A block that specifies the customer’s mailing address. Documented below.
    MiddleName string
    The customer’s middle name.
    MobilePhoneNumber string
    The customer’s mobile phone number.
    PartyTypeString string
    The type of profile used to describe the customer.
    PersonalEmailAddress string
    The customer’s personal email address.
    PhoneNumber string
    The customer’s phone number, which has not been specified as a mobile, home, or business number.
    ShippingAddress ProfileShippingAddressArgs
    A block that specifies the customer’s shipping address. Documented below.
    accountNumber String
    A unique account number that you have given to the customer.
    additionalInformation String
    Any additional information relevant to the customer’s profile.
    address ProfileAddress
    A block that specifies a generic address associated with the customer that is not mailing, shipping, or billing. Documented below.
    attributes Map<String,String>
    A key value pair of attributes of a customer profile.
    billingAddress ProfileBillingAddress
    A block that specifies the customer’s billing address. Documented below.
    birthDate String
    The customer’s birth date.
    businessEmailAddress String
    The customer’s business email address.
    businessName String
    The name of the customer’s business.
    businessPhoneNumber String
    The customer’s business phone number.
    domainName String

    The name of your Customer Profile domain. It must be unique for your AWS account.

    The following arguments are optional:

    emailAddress String
    The customer’s email address, which has not been specified as a personal or business address.
    firstName String
    The customer’s first name.
    genderString String
    The gender with which the customer identifies.
    homePhoneNumber String
    The customer’s home phone number.
    lastName String
    The customer’s last name.
    mailingAddress ProfileMailingAddress
    A block that specifies the customer’s mailing address. Documented below.
    middleName String
    The customer’s middle name.
    mobilePhoneNumber String
    The customer’s mobile phone number.
    partyTypeString String
    The type of profile used to describe the customer.
    personalEmailAddress String
    The customer’s personal email address.
    phoneNumber String
    The customer’s phone number, which has not been specified as a mobile, home, or business number.
    shippingAddress ProfileShippingAddress
    A block that specifies the customer’s shipping address. Documented below.
    accountNumber string
    A unique account number that you have given to the customer.
    additionalInformation string
    Any additional information relevant to the customer’s profile.
    address ProfileAddress
    A block that specifies a generic address associated with the customer that is not mailing, shipping, or billing. Documented below.
    attributes {[key: string]: string}
    A key value pair of attributes of a customer profile.
    billingAddress ProfileBillingAddress
    A block that specifies the customer’s billing address. Documented below.
    birthDate string
    The customer’s birth date.
    businessEmailAddress string
    The customer’s business email address.
    businessName string
    The name of the customer’s business.
    businessPhoneNumber string
    The customer’s business phone number.
    domainName string

    The name of your Customer Profile domain. It must be unique for your AWS account.

    The following arguments are optional:

    emailAddress string
    The customer’s email address, which has not been specified as a personal or business address.
    firstName string
    The customer’s first name.
    genderString string
    The gender with which the customer identifies.
    homePhoneNumber string
    The customer’s home phone number.
    lastName string
    The customer’s last name.
    mailingAddress ProfileMailingAddress
    A block that specifies the customer’s mailing address. Documented below.
    middleName string
    The customer’s middle name.
    mobilePhoneNumber string
    The customer’s mobile phone number.
    partyTypeString string
    The type of profile used to describe the customer.
    personalEmailAddress string
    The customer’s personal email address.
    phoneNumber string
    The customer’s phone number, which has not been specified as a mobile, home, or business number.
    shippingAddress ProfileShippingAddress
    A block that specifies the customer’s shipping address. Documented below.
    account_number str
    A unique account number that you have given to the customer.
    additional_information str
    Any additional information relevant to the customer’s profile.
    address ProfileAddressArgs
    A block that specifies a generic address associated with the customer that is not mailing, shipping, or billing. Documented below.
    attributes Mapping[str, str]
    A key value pair of attributes of a customer profile.
    billing_address ProfileBillingAddressArgs
    A block that specifies the customer’s billing address. Documented below.
    birth_date str
    The customer’s birth date.
    business_email_address str
    The customer’s business email address.
    business_name str
    The name of the customer’s business.
    business_phone_number str
    The customer’s business phone number.
    domain_name str

    The name of your Customer Profile domain. It must be unique for your AWS account.

    The following arguments are optional:

    email_address str
    The customer’s email address, which has not been specified as a personal or business address.
    first_name str
    The customer’s first name.
    gender_string str
    The gender with which the customer identifies.
    home_phone_number str
    The customer’s home phone number.
    last_name str
    The customer’s last name.
    mailing_address ProfileMailingAddressArgs
    A block that specifies the customer’s mailing address. Documented below.
    middle_name str
    The customer’s middle name.
    mobile_phone_number str
    The customer’s mobile phone number.
    party_type_string str
    The type of profile used to describe the customer.
    personal_email_address str
    The customer’s personal email address.
    phone_number str
    The customer’s phone number, which has not been specified as a mobile, home, or business number.
    shipping_address ProfileShippingAddressArgs
    A block that specifies the customer’s shipping address. Documented below.
    accountNumber String
    A unique account number that you have given to the customer.
    additionalInformation String
    Any additional information relevant to the customer’s profile.
    address Property Map
    A block that specifies a generic address associated with the customer that is not mailing, shipping, or billing. Documented below.
    attributes Map<String>
    A key value pair of attributes of a customer profile.
    billingAddress Property Map
    A block that specifies the customer’s billing address. Documented below.
    birthDate String
    The customer’s birth date.
    businessEmailAddress String
    The customer’s business email address.
    businessName String
    The name of the customer’s business.
    businessPhoneNumber String
    The customer’s business phone number.
    domainName String

    The name of your Customer Profile domain. It must be unique for your AWS account.

    The following arguments are optional:

    emailAddress String
    The customer’s email address, which has not been specified as a personal or business address.
    firstName String
    The customer’s first name.
    genderString String
    The gender with which the customer identifies.
    homePhoneNumber String
    The customer’s home phone number.
    lastName String
    The customer’s last name.
    mailingAddress Property Map
    A block that specifies the customer’s mailing address. Documented below.
    middleName String
    The customer’s middle name.
    mobilePhoneNumber String
    The customer’s mobile phone number.
    partyTypeString String
    The type of profile used to describe the customer.
    personalEmailAddress String
    The customer’s personal email address.
    phoneNumber String
    The customer’s phone number, which has not been specified as a mobile, home, or business number.
    shippingAddress Property Map
    A block that specifies the customer’s shipping address. Documented below.

    Supporting Types

    ProfileAddress, ProfileAddressArgs

    Address1 string
    The first line of a customer address.
    Address2 string
    The second line of a customer address.
    Address3 string
    The third line of a customer address.
    Address4 string
    The fourth line of a customer address.
    City string
    The city in which a customer lives.
    Country string
    The country in which a customer lives.
    County string
    The county in which a customer lives.
    PostalCode string
    The postal code of a customer address.
    Province string
    The province in which a customer lives.
    State string
    The state in which a customer lives.
    Address1 string
    The first line of a customer address.
    Address2 string
    The second line of a customer address.
    Address3 string
    The third line of a customer address.
    Address4 string
    The fourth line of a customer address.
    City string
    The city in which a customer lives.
    Country string
    The country in which a customer lives.
    County string
    The county in which a customer lives.
    PostalCode string
    The postal code of a customer address.
    Province string
    The province in which a customer lives.
    State string
    The state in which a customer lives.
    address1 String
    The first line of a customer address.
    address2 String
    The second line of a customer address.
    address3 String
    The third line of a customer address.
    address4 String
    The fourth line of a customer address.
    city String
    The city in which a customer lives.
    country String
    The country in which a customer lives.
    county String
    The county in which a customer lives.
    postalCode String
    The postal code of a customer address.
    province String
    The province in which a customer lives.
    state String
    The state in which a customer lives.
    address1 string
    The first line of a customer address.
    address2 string
    The second line of a customer address.
    address3 string
    The third line of a customer address.
    address4 string
    The fourth line of a customer address.
    city string
    The city in which a customer lives.
    country string
    The country in which a customer lives.
    county string
    The county in which a customer lives.
    postalCode string
    The postal code of a customer address.
    province string
    The province in which a customer lives.
    state string
    The state in which a customer lives.
    address1 str
    The first line of a customer address.
    address2 str
    The second line of a customer address.
    address3 str
    The third line of a customer address.
    address4 str
    The fourth line of a customer address.
    city str
    The city in which a customer lives.
    country str
    The country in which a customer lives.
    county str
    The county in which a customer lives.
    postal_code str
    The postal code of a customer address.
    province str
    The province in which a customer lives.
    state str
    The state in which a customer lives.
    address1 String
    The first line of a customer address.
    address2 String
    The second line of a customer address.
    address3 String
    The third line of a customer address.
    address4 String
    The fourth line of a customer address.
    city String
    The city in which a customer lives.
    country String
    The country in which a customer lives.
    county String
    The county in which a customer lives.
    postalCode String
    The postal code of a customer address.
    province String
    The province in which a customer lives.
    state String
    The state in which a customer lives.

    ProfileBillingAddress, ProfileBillingAddressArgs

    Address1 string
    The first line of a customer address.
    Address2 string
    The second line of a customer address.
    Address3 string
    The third line of a customer address.
    Address4 string
    The fourth line of a customer address.
    City string
    The city in which a customer lives.
    Country string
    The country in which a customer lives.
    County string
    The county in which a customer lives.
    PostalCode string
    The postal code of a customer address.
    Province string
    The province in which a customer lives.
    State string
    The state in which a customer lives.
    Address1 string
    The first line of a customer address.
    Address2 string
    The second line of a customer address.
    Address3 string
    The third line of a customer address.
    Address4 string
    The fourth line of a customer address.
    City string
    The city in which a customer lives.
    Country string
    The country in which a customer lives.
    County string
    The county in which a customer lives.
    PostalCode string
    The postal code of a customer address.
    Province string
    The province in which a customer lives.
    State string
    The state in which a customer lives.
    address1 String
    The first line of a customer address.
    address2 String
    The second line of a customer address.
    address3 String
    The third line of a customer address.
    address4 String
    The fourth line of a customer address.
    city String
    The city in which a customer lives.
    country String
    The country in which a customer lives.
    county String
    The county in which a customer lives.
    postalCode String
    The postal code of a customer address.
    province String
    The province in which a customer lives.
    state String
    The state in which a customer lives.
    address1 string
    The first line of a customer address.
    address2 string
    The second line of a customer address.
    address3 string
    The third line of a customer address.
    address4 string
    The fourth line of a customer address.
    city string
    The city in which a customer lives.
    country string
    The country in which a customer lives.
    county string
    The county in which a customer lives.
    postalCode string
    The postal code of a customer address.
    province string
    The province in which a customer lives.
    state string
    The state in which a customer lives.
    address1 str
    The first line of a customer address.
    address2 str
    The second line of a customer address.
    address3 str
    The third line of a customer address.
    address4 str
    The fourth line of a customer address.
    city str
    The city in which a customer lives.
    country str
    The country in which a customer lives.
    county str
    The county in which a customer lives.
    postal_code str
    The postal code of a customer address.
    province str
    The province in which a customer lives.
    state str
    The state in which a customer lives.
    address1 String
    The first line of a customer address.
    address2 String
    The second line of a customer address.
    address3 String
    The third line of a customer address.
    address4 String
    The fourth line of a customer address.
    city String
    The city in which a customer lives.
    country String
    The country in which a customer lives.
    county String
    The county in which a customer lives.
    postalCode String
    The postal code of a customer address.
    province String
    The province in which a customer lives.
    state String
    The state in which a customer lives.

    ProfileMailingAddress, ProfileMailingAddressArgs

    Address1 string
    The first line of a customer address.
    Address2 string
    The second line of a customer address.
    Address3 string
    The third line of a customer address.
    Address4 string
    The fourth line of a customer address.
    City string
    The city in which a customer lives.
    Country string
    The country in which a customer lives.
    County string
    The county in which a customer lives.
    PostalCode string
    The postal code of a customer address.
    Province string
    The province in which a customer lives.
    State string
    The state in which a customer lives.
    Address1 string
    The first line of a customer address.
    Address2 string
    The second line of a customer address.
    Address3 string
    The third line of a customer address.
    Address4 string
    The fourth line of a customer address.
    City string
    The city in which a customer lives.
    Country string
    The country in which a customer lives.
    County string
    The county in which a customer lives.
    PostalCode string
    The postal code of a customer address.
    Province string
    The province in which a customer lives.
    State string
    The state in which a customer lives.
    address1 String
    The first line of a customer address.
    address2 String
    The second line of a customer address.
    address3 String
    The third line of a customer address.
    address4 String
    The fourth line of a customer address.
    city String
    The city in which a customer lives.
    country String
    The country in which a customer lives.
    county String
    The county in which a customer lives.
    postalCode String
    The postal code of a customer address.
    province String
    The province in which a customer lives.
    state String
    The state in which a customer lives.
    address1 string
    The first line of a customer address.
    address2 string
    The second line of a customer address.
    address3 string
    The third line of a customer address.
    address4 string
    The fourth line of a customer address.
    city string
    The city in which a customer lives.
    country string
    The country in which a customer lives.
    county string
    The county in which a customer lives.
    postalCode string
    The postal code of a customer address.
    province string
    The province in which a customer lives.
    state string
    The state in which a customer lives.
    address1 str
    The first line of a customer address.
    address2 str
    The second line of a customer address.
    address3 str
    The third line of a customer address.
    address4 str
    The fourth line of a customer address.
    city str
    The city in which a customer lives.
    country str
    The country in which a customer lives.
    county str
    The county in which a customer lives.
    postal_code str
    The postal code of a customer address.
    province str
    The province in which a customer lives.
    state str
    The state in which a customer lives.
    address1 String
    The first line of a customer address.
    address2 String
    The second line of a customer address.
    address3 String
    The third line of a customer address.
    address4 String
    The fourth line of a customer address.
    city String
    The city in which a customer lives.
    country String
    The country in which a customer lives.
    county String
    The county in which a customer lives.
    postalCode String
    The postal code of a customer address.
    province String
    The province in which a customer lives.
    state String
    The state in which a customer lives.

    ProfileShippingAddress, ProfileShippingAddressArgs

    Address1 string
    The first line of a customer address.
    Address2 string
    The second line of a customer address.
    Address3 string
    The third line of a customer address.
    Address4 string
    The fourth line of a customer address.
    City string
    The city in which a customer lives.
    Country string
    The country in which a customer lives.
    County string
    The county in which a customer lives.
    PostalCode string
    The postal code of a customer address.
    Province string
    The province in which a customer lives.
    State string
    The state in which a customer lives.
    Address1 string
    The first line of a customer address.
    Address2 string
    The second line of a customer address.
    Address3 string
    The third line of a customer address.
    Address4 string
    The fourth line of a customer address.
    City string
    The city in which a customer lives.
    Country string
    The country in which a customer lives.
    County string
    The county in which a customer lives.
    PostalCode string
    The postal code of a customer address.
    Province string
    The province in which a customer lives.
    State string
    The state in which a customer lives.
    address1 String
    The first line of a customer address.
    address2 String
    The second line of a customer address.
    address3 String
    The third line of a customer address.
    address4 String
    The fourth line of a customer address.
    city String
    The city in which a customer lives.
    country String
    The country in which a customer lives.
    county String
    The county in which a customer lives.
    postalCode String
    The postal code of a customer address.
    province String
    The province in which a customer lives.
    state String
    The state in which a customer lives.
    address1 string
    The first line of a customer address.
    address2 string
    The second line of a customer address.
    address3 string
    The third line of a customer address.
    address4 string
    The fourth line of a customer address.
    city string
    The city in which a customer lives.
    country string
    The country in which a customer lives.
    county string
    The county in which a customer lives.
    postalCode string
    The postal code of a customer address.
    province string
    The province in which a customer lives.
    state string
    The state in which a customer lives.
    address1 str
    The first line of a customer address.
    address2 str
    The second line of a customer address.
    address3 str
    The third line of a customer address.
    address4 str
    The fourth line of a customer address.
    city str
    The city in which a customer lives.
    country str
    The country in which a customer lives.
    county str
    The county in which a customer lives.
    postal_code str
    The postal code of a customer address.
    province str
    The province in which a customer lives.
    state str
    The state in which a customer lives.
    address1 String
    The first line of a customer address.
    address2 String
    The second line of a customer address.
    address3 String
    The third line of a customer address.
    address4 String
    The fourth line of a customer address.
    city String
    The city in which a customer lives.
    country String
    The country in which a customer lives.
    county String
    The county in which a customer lives.
    postalCode String
    The postal code of a customer address.
    province String
    The province in which a customer lives.
    state String
    The state in which a customer lives.

    Import

    Using pulumi import, import Amazon Customer Profiles Profile using the resource id. For example:

    $ pulumi import aws:customerprofiles/profile:Profile example domain-name/5f2f473dfbe841eb8d05cfc2a4c926df

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-aws