Package com.pulumi.aws.customerprofiles

Class Profile

  • public class Profile
extends com.pulumi.resources.CustomResource
    Resource for managing an Amazon Customer Profiles Profile. See the [Create Profile](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateProfile.html) for more information. ## Example Usage 
     
 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());
 
     }
 }
    ## Import Using `pulumi import`, import Amazon Customer Profiles Profile using the resource `id`. For example: ```sh $ pulumi import aws:customerprofiles/profile:Profile example domain-name/5f2f473dfbe841eb8d05cfc2a4c926df ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Profile​(java.lang.String name)  
      Profile​(java.lang.String name, ProfileArgs args)  
      Profile​(java.lang.String name, ProfileArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> accountNumber()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> additionalInformation()  
      com.pulumi.core.Output<java.util.Optional<ProfileAddress>> address()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> attributes()  
      com.pulumi.core.Output<java.util.Optional<ProfileBillingAddress>> billingAddress()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> birthDate()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> businessEmailAddress()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> businessName()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> businessPhoneNumber()  
      com.pulumi.core.Output<java.lang.String> domainName()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> emailAddress()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> firstName()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> genderString()  
      static Profile get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ProfileState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> homePhoneNumber()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> lastName()  
      com.pulumi.core.Output<java.util.Optional<ProfileMailingAddress>> mailingAddress()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> middleName()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> mobilePhoneNumber()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> partyTypeString()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> personalEmailAddress()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> phoneNumber()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<ProfileShippingAddress>> shippingAddress()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Profile

        public Profile​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Profile

        public Profile​(java.lang.String name,
               ProfileArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Profile

        public Profile​(java.lang.String name,
               ProfileArgs args,
               @Nullable
               com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • accountNumber

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> accountNumber()
        Returns:
        A unique account number that you have given to the customer.

      • additionalInformation

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> additionalInformation()
        Returns:
        Any additional information relevant to the customer’s profile.

      • address

        public com.pulumi.core.Output<java.util.Optional<ProfileAddress>> address()
        Returns:
        A block that specifies a generic address associated with the customer that is not mailing, shipping, or billing. Documented below.

      • attributes

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> attributes()
        Returns:
        A key value pair of attributes of a customer profile.

      • billingAddress

        public com.pulumi.core.Output<java.util.Optional<ProfileBillingAddress>> billingAddress()
        Returns:
        A block that specifies the customer’s billing address. Documented below.

      • birthDate

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> birthDate()
        Returns:
        The customer’s birth date.

      • businessEmailAddress

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> businessEmailAddress()
        Returns:
        The customer’s business email address.

      • businessName

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> businessName()
        Returns:
        The name of the customer’s business.

      • businessPhoneNumber

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> businessPhoneNumber()
        Returns:
        The customer’s business phone number.

      • domainName

        public com.pulumi.core.Output<java.lang.String> domainName()
        Returns:
        The name of your Customer Profile domain. It must be unique for your AWS account. The following arguments are optional:

      • emailAddress

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> emailAddress()
        Returns:
        The customer’s email address, which has not been specified as a personal or business address.

      • firstName

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> firstName()
        Returns:
        The customer’s first name.

      • genderString

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> genderString()
        Returns:
        The gender with which the customer identifies.

      • homePhoneNumber

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> homePhoneNumber()
        Returns:
        The customer’s home phone number.

      • lastName

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> lastName()
        Returns:
        The customer’s last name.

      • mailingAddress

        public com.pulumi.core.Output<java.util.Optional<ProfileMailingAddress>> mailingAddress()
        Returns:
        A block that specifies the customer’s mailing address. Documented below.

      • middleName

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> middleName()
        Returns:
        The customer’s middle name.

      • mobilePhoneNumber

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> mobilePhoneNumber()
        Returns:
        The customer’s mobile phone number.

      • partyTypeString

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> partyTypeString()
        Returns:
        The type of profile used to describe the customer.

      • personalEmailAddress

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> personalEmailAddress()
        Returns:
        The customer’s personal email address.

      • phoneNumber

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> phoneNumber()
        Returns:
        The customer’s phone number, which has not been specified as a mobile, home, or business number.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • shippingAddress

        public com.pulumi.core.Output<java.util.Optional<ProfileShippingAddress>> shippingAddress()
        Returns:
        A block that specifies the customer’s shipping address. Documented below.

      • get

        public static Profile get​(java.lang.String name,
                          com.pulumi.core.Output<java.lang.String> id,
                          @Nullable
                          ProfileState state,
                          @Nullable
                          com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.