Package software.amazon.awscdk.services.b2bi

Class CfnProfile

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.b2bi.CfnProfile
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggableV2, IProfileRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:39:58.958Z") @Stability(Stable) public class CfnProfile extends CfnResource implements IInspectable, IProfileRef, ITaggableV2
Creates a customer profile.

You can have up to five customer profiles, each representing a distinct private network. A profile is the mechanism used to create the concept of a private network.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.b2bi.*;
 CfnProfile cfnProfile = CfnProfile.Builder.create(this, "MyCfnProfile")
         .businessName("businessName")
         .logging("logging")
         .name("name")
         .phone("phone")
         // the properties below are optional
         .email("email")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnProfile

      protected CfnProfile(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnProfile

      protected CfnProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnProfile

      @Stability(Stable) public CfnProfile(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnProfileProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      Returns the timestamp for creation date and time of the profile.

    • getAttrLogGroupName

      @Stability(Stable) @NotNull public String getAttrLogGroupName()
      Returns the name of the logging group.

    • getAttrModifiedAt

      @Stability(Stable) @NotNull public String getAttrModifiedAt()
      Returns the timestamp that identifies the most recent date and time that the profile was modified.

    • getAttrProfileArn

      @Stability(Stable) @NotNull public String getAttrProfileArn()
      Returns an Amazon Resource Name (ARN) for the profile.

    • getAttrProfileId

      @Stability(Stable) @NotNull public String getAttrProfileId()

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getProfileRef

      @Stability(Stable) @NotNull public ProfileReference getProfileRef()
      A reference to a Profile resource.
      Specified by:
      getProfileRef in interface IProfileRef

    • getBusinessName

      @Stability(Stable) @NotNull public String getBusinessName()
      Returns the name for the business associated with this profile.

    • setBusinessName

      @Stability(Stable) public void setBusinessName(@NotNull String value)
      Returns the name for the business associated with this profile.

    • getLogging

      @Stability(Stable) @NotNull public String getLogging()
      Specifies whether or not logging is enabled for this profile.

    • setLogging

      @Stability(Stable) public void setLogging(@NotNull String value)
      Specifies whether or not logging is enabled for this profile.

    • getName

      @Stability(Stable) @NotNull public String getName()
      Returns the display name for profile.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      Returns the display name for profile.

    • getPhone

      @Stability(Stable) @NotNull public String getPhone()
      Specifies the phone number associated with the profile.

    • setPhone

      @Stability(Stable) public void setPhone(@NotNull String value)
      Specifies the phone number associated with the profile.

    • getEmail

      @Stability(Stable) @Nullable public String getEmail()

    • setEmail

      @Stability(Stable) public void setEmail(@Nullable String value)

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A key-value pair for a specific profile.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A key-value pair for a specific profile.