Profile class
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)
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 main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_customerprofiles_domain" "example" {
domain_name = "example"
}
resource "aws_customerprofiles_profile" "example" {
domain_name = aws_customerprofiles_domain.example.domain_name
}
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.ArrayList;
import java.util.Arrays;
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}
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
Constructors
- Profile(String name, {ProfileArgs? args, CustomResourceOptions? options})
-
Creates a new Profile.
nameThe Pulumi resource name.argsArguments used to configure this Profile. The set of arguments for Profile.optionsResource options controlling this resource's behavior. - Profile.reference(String urn)
- Creates a typed reference to an existing Profile resource.
Properties
-
accountNumber
↔ Output<
String?> -
A unique account number that you have given to the customer.
latefinal
-
additionalInformation
↔ Output<
String?> -
Any additional information relevant to the customer’s profile.
latefinal
-
address
↔ Output<
ProfileAddress?> -
A block that specifies a generic address associated with the customer that is not mailing, shipping, or billing. Documented below.
latefinal
-
attributes
↔ Output<
Map< String, String> ?> -
A key value pair of attributes of a customer profile.
latefinal
-
billingAddress
↔ Output<
ProfileBillingAddress?> -
A block that specifies the customer’s billing address. Documented below.
latefinal
-
birthDate
↔ Output<
String?> -
The customer’s birth date.
latefinal
-
businessEmailAddress
↔ Output<
String?> -
The customer’s business email address.
latefinal
-
businessName
↔ Output<
String?> -
The name of the customer’s business.
latefinal
-
businessPhoneNumber
↔ Output<
String?> -
The customer’s business phone number.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
domainName
↔ Output<
String> -
The name of your Customer Profile domain. It must be unique for your AWS account.
latefinal
-
emailAddress
↔ Output<
String?> -
The customer’s email address, which has not been specified as a personal or business address.
latefinal
-
firstName
↔ Output<
String?> -
The customer’s first name.
latefinal
-
genderString
↔ Output<
String?> -
The gender with which the customer identifies.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
homePhoneNumber
↔ Output<
String?> -
The customer’s home phone number.
latefinal
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
lastName
↔ Output<
String?> -
The customer’s last name.
latefinal
-
mailingAddress
↔ Output<
ProfileMailingAddress?> -
A block that specifies the customer’s mailing address. Documented below.
latefinal
-
middleName
↔ Output<
String?> -
The customer’s middle name.
latefinal
-
mobilePhoneNumber
↔ Output<
String?> -
The customer’s mobile phone number.
latefinal
-
partyTypeString
↔ Output<
String?> -
The type of profile used to describe the customer.
latefinal
-
personalEmailAddress
↔ Output<
String?> -
The customer’s personal email address.
latefinal
-
phoneNumber
↔ Output<
String?> -
The customer’s phone number, which has not been specified as a mobile, home, or business number.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
shippingAddress
↔ Output<
ProfileShippingAddress?> -
A block that specifies the customer’s shipping address. Documented below.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited