Package software.amazon.awscdk.services.invoicing

Class CfnProcurementPortalPreference

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.invoicing.CfnProcurementPortalPreference
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IProcurementPortalPreferenceRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:11.713Z") @Stability(Stable) public class CfnProcurementPortalPreference extends CfnResource implements IInspectable, IProcurementPortalPreferenceRef, ITaggableV2
Creates and manages a procurement portal preference configuration for e-invoice delivery and purchase order retrieval.

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.invoicing.*;
 CfnProcurementPortalPreference cfnProcurementPortalPreference = CfnProcurementPortalPreference.Builder.create(this, "MyCfnProcurementPortalPreference")
         .buyerDomain("buyerDomain")
         .buyerIdentifier("buyerIdentifier")
         .contacts(List.of(ContactProperty.builder()
                 .email("email")
                 .name("name")
                 .build()))
         .einvoiceDeliveryEnabled(false)
         .procurementPortalName("procurementPortalName")
         .purchaseOrderRetrievalEnabled(false)
         .supplierDomain("supplierDomain")
         .supplierIdentifier("supplierIdentifier")
         // the properties below are optional
         .einvoiceDeliveryPreference(EinvoiceDeliveryPreferenceProperty.builder()
                 .connectionTestingMethod("connectionTestingMethod")
                 .einvoiceDeliveryActivationDate("einvoiceDeliveryActivationDate")
                 .einvoiceDeliveryAttachmentTypes(List.of("einvoiceDeliveryAttachmentTypes"))
                 .einvoiceDeliveryDocumentTypes(List.of("einvoiceDeliveryDocumentTypes"))
                 .protocol("protocol")
                 .purchaseOrderDataSources(List.of(PurchaseOrderDataSourceProperty.builder()
                         .einvoiceDeliveryDocumentType("einvoiceDeliveryDocumentType")
                         .purchaseOrderDataSourceType("purchaseOrderDataSourceType")
                         .build()))
                 .build())
         .procurementPortalInstanceEndpoint("procurementPortalInstanceEndpoint")
         .procurementPortalSharedSecret("procurementPortalSharedSecret")
         .selector(ProcurementPortalPreferenceSelectorProperty.builder()
                 .invoiceUnitArns(List.of("invoiceUnitArns"))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .testEnvPreference(TestEnvPreferenceProperty.builder()
                 .buyerDomain("buyerDomain")
                 .buyerIdentifier("buyerIdentifier")
                 .procurementPortalInstanceEndpoint("procurementPortalInstanceEndpoint")
                 .procurementPortalSharedSecret("procurementPortalSharedSecret")
                 .supplierDomain("supplierDomain")
                 .supplierIdentifier("supplierIdentifier")
                 .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

    • CfnProcurementPortalPreference

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

    • CfnProcurementPortalPreference

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

    • CfnProcurementPortalPreference

      @Stability(Stable) public CfnProcurementPortalPreference(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnProcurementPortalPreferenceProps props)
      Create a new AWS::Invoicing::ProcurementPortalPreference.

      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

    • arnForProcurementPortalPreference

      @Stability(Stable) @NotNull public static String arnForProcurementPortalPreference(@NotNull IProcurementPortalPreferenceRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnProcurementPortalPreference

      @Stability(Stable) @NotNull public static Boolean isCfnProcurementPortalPreference(@NotNull Object x)
      Checks whether the given object is a CfnProcurementPortalPreference.

      Parameters:
      x - This parameter is required.

    • 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.

    • getAttrAwsAccountId

      @Stability(Stable) @NotNull public String getAttrAwsAccountId()
      The AWS account ID associated with this procurement portal preference.

    • getAttrCreateDate

      @Stability(Stable) @NotNull public String getAttrCreateDate()
      The date and time when the procurement portal preference was created.

    • getAttrEinvoiceDeliveryPreferenceStatus

      @Stability(Stable) @NotNull public String getAttrEinvoiceDeliveryPreferenceStatus()
      The current status of the e-invoice delivery preference.

    • getAttrLastUpdateDate

      @Stability(Stable) @NotNull public String getAttrLastUpdateDate()
      The date and time when the procurement portal preference was last updated.

    • getAttrProcurementPortalPreferenceArn

      @Stability(Stable) @NotNull public String getAttrProcurementPortalPreferenceArn()
      The Amazon Resource Name (ARN) of the procurement portal preference.

    • getAttrPurchaseOrderRetrievalEndpoint

      @Stability(Stable) @NotNull public String getAttrPurchaseOrderRetrievalEndpoint()
      The endpoint URL used for retrieving purchase orders from the procurement portal.

    • getAttrPurchaseOrderRetrievalPreferenceStatus

      @Stability(Stable) @NotNull public String getAttrPurchaseOrderRetrievalPreferenceStatus()
      The current status of the purchase order retrieval preference.

    • getAttrVersion

      @Stability(Stable) @NotNull public Number getAttrVersion()
      The version number of the procurement portal preference configuration.

    • 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

    • getCfnPropertyNames

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

    • getProcurementPortalPreferenceRef

      @Stability(Stable) @NotNull public ProcurementPortalPreferenceReference getProcurementPortalPreferenceRef()
      A reference to a ProcurementPortalPreference resource.
      Specified by:
      getProcurementPortalPreferenceRef in interface IProcurementPortalPreferenceRef

    • getBuyerDomain

      @Stability(Stable) @NotNull public String getBuyerDomain()
      The domain identifier for the buyer in the procurement portal.

    • setBuyerDomain

      @Stability(Stable) public void setBuyerDomain(@NotNull String value)
      The domain identifier for the buyer in the procurement portal.

    • getBuyerIdentifier

      @Stability(Stable) @NotNull public String getBuyerIdentifier()
      The unique identifier for the buyer in the procurement portal.

    • setBuyerIdentifier

      @Stability(Stable) public void setBuyerIdentifier(@NotNull String value)
      The unique identifier for the buyer in the procurement portal.

    • getContacts

      @Stability(Stable) @NotNull public Object getContacts()
      List of contact information for portal administrators and technical contacts.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnProcurementPortalPreference.ContactProperty>

    • setContacts

      @Stability(Stable) public void setContacts(@NotNull IResolvable value)
      List of contact information for portal administrators and technical contacts.

    • setContacts

      @Stability(Stable) public void setContacts(@NotNull List<Object> value)
      List of contact information for portal administrators and technical contacts.

    • getEinvoiceDeliveryEnabled

      @Stability(Stable) @NotNull public Object getEinvoiceDeliveryEnabled()
      Indicates whether e-invoice delivery is enabled for this procurement portal preference.

      Returns union: either Boolean or IResolvable

    • setEinvoiceDeliveryEnabled

      @Stability(Stable) public void setEinvoiceDeliveryEnabled(@NotNull Boolean value)
      Indicates whether e-invoice delivery is enabled for this procurement portal preference.

    • setEinvoiceDeliveryEnabled

      @Stability(Stable) public void setEinvoiceDeliveryEnabled(@NotNull IResolvable value)
      Indicates whether e-invoice delivery is enabled for this procurement portal preference.

    • getProcurementPortalName

      @Stability(Stable) @NotNull public String getProcurementPortalName()
      The name of the procurement portal.

    • setProcurementPortalName

      @Stability(Stable) public void setProcurementPortalName(@NotNull String value)
      The name of the procurement portal.

    • getPurchaseOrderRetrievalEnabled

      @Stability(Stable) @NotNull public Object getPurchaseOrderRetrievalEnabled()
      Indicates whether purchase order retrieval is enabled for this procurement portal preference.

      Returns union: either Boolean or IResolvable

    • setPurchaseOrderRetrievalEnabled

      @Stability(Stable) public void setPurchaseOrderRetrievalEnabled(@NotNull Boolean value)
      Indicates whether purchase order retrieval is enabled for this procurement portal preference.

    • setPurchaseOrderRetrievalEnabled

      @Stability(Stable) public void setPurchaseOrderRetrievalEnabled(@NotNull IResolvable value)
      Indicates whether purchase order retrieval is enabled for this procurement portal preference.

    • getSupplierDomain

      @Stability(Stable) @NotNull public String getSupplierDomain()
      The domain identifier for the supplier in the procurement portal.

    • setSupplierDomain

      @Stability(Stable) public void setSupplierDomain(@NotNull String value)
      The domain identifier for the supplier in the procurement portal.

    • getSupplierIdentifier

      @Stability(Stable) @NotNull public String getSupplierIdentifier()
      The unique identifier for the supplier in the procurement portal.

    • setSupplierIdentifier

      @Stability(Stable) public void setSupplierIdentifier(@NotNull String value)
      The unique identifier for the supplier in the procurement portal.

    • getEinvoiceDeliveryPreference

      @Stability(Stable) @Nullable public Object getEinvoiceDeliveryPreference()
      Specifies the preferences for e-invoice delivery.

      Returns union: either IResolvable or CfnProcurementPortalPreference.EinvoiceDeliveryPreferenceProperty

    • setEinvoiceDeliveryPreference

      @Stability(Stable) public void setEinvoiceDeliveryPreference(@Nullable IResolvable value)
      Specifies the preferences for e-invoice delivery.

    • setEinvoiceDeliveryPreference

      @Stability(Stable) public void setEinvoiceDeliveryPreference(@Nullable CfnProcurementPortalPreference.EinvoiceDeliveryPreferenceProperty value)
      Specifies the preferences for e-invoice delivery.

    • getProcurementPortalInstanceEndpoint

      @Stability(Stable) @Nullable public String getProcurementPortalInstanceEndpoint()
      The endpoint URL where e-invoices are delivered to the procurement portal.

    • setProcurementPortalInstanceEndpoint

      @Stability(Stable) public void setProcurementPortalInstanceEndpoint(@Nullable String value)
      The endpoint URL where e-invoices are delivered to the procurement portal.

    • getProcurementPortalSharedSecret

      @Stability(Stable) @Nullable public String getProcurementPortalSharedSecret()
      The shared secret or authentication credential used for secure communication with the procurement portal.

    • setProcurementPortalSharedSecret

      @Stability(Stable) public void setProcurementPortalSharedSecret(@Nullable String value)
      The shared secret or authentication credential used for secure communication with the procurement portal.

    • getSelector

      @Stability(Stable) @Nullable public Object getSelector()
      Specifies criteria for selecting which invoices should be processed.

      Returns union: either IResolvable or CfnProcurementPortalPreference.ProcurementPortalPreferenceSelectorProperty

    • setSelector

      @Stability(Stable) public void setSelector(@Nullable IResolvable value)
      Specifies criteria for selecting which invoices should be processed.

    • setSelector

      @Stability(Stable) public void setSelector(@Nullable CfnProcurementPortalPreference.ProcurementPortalPreferenceSelectorProperty value)
      Specifies criteria for selecting which invoices should be processed.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags associated with this procurement portal preference.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags associated with this procurement portal preference.

    • getTestEnvPreference

      @Stability(Stable) @Nullable public Object getTestEnvPreference()
      Configuration settings for the test environment of the procurement portal.

      Returns union: either IResolvable or CfnProcurementPortalPreference.TestEnvPreferenceProperty

    • setTestEnvPreference

      @Stability(Stable) public void setTestEnvPreference(@Nullable IResolvable value)
      Configuration settings for the test environment of the procurement portal.

    • setTestEnvPreference

      @Stability(Stable) public void setTestEnvPreference(@Nullable CfnProcurementPortalPreference.TestEnvPreferenceProperty value)
      Configuration settings for the test environment of the procurement portal.