CfnProcurementPortalPreferencePropsMixin

class aws_cdk.cfn_property_mixins.aws_invoicing.CfnProcurementPortalPreferencePropsMixin(props, *, strategy=None)

Bases: Mixin

Creates and manages a procurement portal preference configuration for e-invoice delivery and purchase order retrieval.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-invoicing-procurementportalpreference.html
CloudformationResource:: AWS::Invoicing::ProcurementPortalPreference
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_invoicing as invoicing
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_procurement_portal_preference_props_mixin = invoicing.CfnProcurementPortalPreferencePropsMixin(invoicing.CfnProcurementPortalPreferenceMixinProps(
    buyer_domain="buyerDomain",
    buyer_identifier="buyerIdentifier",
    contacts=[invoicing.CfnProcurementPortalPreferencePropsMixin.ContactProperty(
        email="email",
        name="name"
    )],
    einvoice_delivery_enabled=False,
    einvoice_delivery_preference=invoicing.CfnProcurementPortalPreferencePropsMixin.EinvoiceDeliveryPreferenceProperty(
        connection_testing_method="connectionTestingMethod",
        einvoice_delivery_activation_date="einvoiceDeliveryActivationDate",
        einvoice_delivery_attachment_types=["einvoiceDeliveryAttachmentTypes"],
        einvoice_delivery_document_types=["einvoiceDeliveryDocumentTypes"],
        protocol="protocol",
        purchase_order_data_sources=[invoicing.CfnProcurementPortalPreferencePropsMixin.PurchaseOrderDataSourceProperty(
            einvoice_delivery_document_type="einvoiceDeliveryDocumentType",
            purchase_order_data_source_type="purchaseOrderDataSourceType"
        )]
    ),
    procurement_portal_instance_endpoint="procurementPortalInstanceEndpoint",
    procurement_portal_name="procurementPortalName",
    procurement_portal_shared_secret="procurementPortalSharedSecret",
    purchase_order_retrieval_enabled=False,
    selector=invoicing.CfnProcurementPortalPreferencePropsMixin.ProcurementPortalPreferenceSelectorProperty(
        invoice_unit_arns=["invoiceUnitArns"]
    ),
    supplier_domain="supplierDomain",
    supplier_identifier="supplierIdentifier",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )],
    test_env_preference=invoicing.CfnProcurementPortalPreferencePropsMixin.TestEnvPreferenceProperty(
        buyer_domain="buyerDomain",
        buyer_identifier="buyerIdentifier",
        procurement_portal_instance_endpoint="procurementPortalInstanceEndpoint",
        procurement_portal_shared_secret="procurementPortalSharedSecret",
        supplier_domain="supplierDomain",
        supplier_identifier="supplierIdentifier"
    )
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::Invoicing::ProcurementPortalPreference.

Parameters:

props (Union[CfnProcurementPortalPreferenceMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['buyerDomain', 'buyerIdentifier', 'contacts', 'einvoiceDeliveryEnabled', 'einvoiceDeliveryPreference', 'procurementPortalInstanceEndpoint', 'procurementPortalName', 'procurementPortalSharedSecret', 'purchaseOrderRetrievalEnabled', 'selector', 'supplierDomain', 'supplierIdentifier', 'tags', 'testEnvPreference']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

ContactProperty

class CfnProcurementPortalPreferencePropsMixin.ContactProperty(*, email=None, name=None)

Bases: object

Contact information for a person or role associated with the procurement portal preference.

Parameters:

email (Optional[str]) – The email address of the contact person or role.
name (Optional[str]) – The name of the contact person or role.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-invoicing-procurementportalpreference-contact.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_invoicing as invoicing

contact_property = invoicing.CfnProcurementPortalPreferencePropsMixin.ContactProperty(
    email="email",
    name="name"
)

Attributes

email

The email address of the contact person or role.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-invoicing-procurementportalpreference-contact.html#cfn-invoicing-procurementportalpreference-contact-email

name

The name of the contact person or role.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-invoicing-procurementportalpreference-contact.html#cfn-invoicing-procurementportalpreference-contact-name

EinvoiceDeliveryPreferenceProperty

class CfnProcurementPortalPreferencePropsMixin.EinvoiceDeliveryPreferenceProperty(*, connection_testing_method=None, einvoice_delivery_activation_date=None, einvoice_delivery_attachment_types=None, einvoice_delivery_document_types=None, protocol=None, purchase_order_data_sources=None)

Bases: object

Specifies the preferences for e-invoice delivery.

Parameters:

connection_testing_method (Optional[str]) – The method to use for testing the connection to the procurement portal.
einvoice_delivery_activation_date (Optional[str]) – The ISO 8601 date-time when e-invoice delivery should be activated.
einvoice_delivery_attachment_types (Optional[Sequence[str]]) – The types of attachments to include with the e-invoice delivery.
einvoice_delivery_document_types (Optional[Sequence[str]]) – The types of e-invoice documents to be delivered.
protocol (Optional[str]) – The communication protocol to use for e-invoice delivery.
purchase_order_data_sources (Union[IResolvable, Sequence[Union[IResolvable, PurchaseOrderDataSourceProperty, Dict[str, Any]]], None]) – The sources of purchase order data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-invoicing-procurementportalpreference-einvoicedeliverypreference.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_invoicing as invoicing

einvoice_delivery_preference_property = invoicing.CfnProcurementPortalPreferencePropsMixin.EinvoiceDeliveryPreferenceProperty(
    connection_testing_method="connectionTestingMethod",
    einvoice_delivery_activation_date="einvoiceDeliveryActivationDate",
    einvoice_delivery_attachment_types=["einvoiceDeliveryAttachmentTypes"],
    einvoice_delivery_document_types=["einvoiceDeliveryDocumentTypes"],
    protocol="protocol",
    purchase_order_data_sources=[invoicing.CfnProcurementPortalPreferencePropsMixin.PurchaseOrderDataSourceProperty(
        einvoice_delivery_document_type="einvoiceDeliveryDocumentType",
        purchase_order_data_source_type="purchaseOrderDataSourceType"
    )]
)

Attributes

connection_testing_method

The method to use for testing the connection to the procurement portal.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-invoicing-procurementportalpreference-einvoicedeliverypreference.html#cfn-invoicing-procurementportalpreference-einvoicedeliverypreference-connectiontestingmethod

einvoice_delivery_activation_date

The ISO 8601 date-time when e-invoice delivery should be activated.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-invoicing-procurementportalpreference-einvoicedeliverypreference.html#cfn-invoicing-procurementportalpreference-einvoicedeliverypreference-einvoicedeliveryactivationdate

einvoice_delivery_attachment_types

The types of attachments to include with the e-invoice delivery.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-invoicing-procurementportalpreference-einvoicedeliverypreference.html#cfn-invoicing-procurementportalpreference-einvoicedeliverypreference-einvoicedeliveryattachmenttypes

einvoice_delivery_document_types

The types of e-invoice documents to be delivered.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-invoicing-procurementportalpreference-einvoicedeliverypreference.html#cfn-invoicing-procurementportalpreference-einvoicedeliverypreference-einvoicedeliverydocumenttypes

protocol

The communication protocol to use for e-invoice delivery.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-invoicing-procurementportalpreference-einvoicedeliverypreference.html#cfn-invoicing-procurementportalpreference-einvoicedeliverypreference-protocol

purchase_order_data_sources

The sources of purchase order data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-invoicing-procurementportalpreference-einvoicedeliverypreference.html#cfn-invoicing-procurementportalpreference-einvoicedeliverypreference-purchaseorderdatasources

ProcurementPortalPreferenceSelectorProperty

class CfnProcurementPortalPreferencePropsMixin.ProcurementPortalPreferenceSelectorProperty(*, invoice_unit_arns=None)

Bases: object

Specifies criteria for selecting which invoices should be processed.

Parameters:: invoice_unit_arns (Optional[Sequence[str]]) – The Amazon Resource Name (ARN) of invoice unit identifiers to which this preference applies.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-invoicing-procurementportalpreference-procurementportalpreferenceselector.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_invoicing as invoicing

procurement_portal_preference_selector_property = invoicing.CfnProcurementPortalPreferencePropsMixin.ProcurementPortalPreferenceSelectorProperty(
    invoice_unit_arns=["invoiceUnitArns"]
)

Attributes

invoice_unit_arns

The Amazon Resource Name (ARN) of invoice unit identifiers to which this preference applies.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-invoicing-procurementportalpreference-procurementportalpreferenceselector.html#cfn-invoicing-procurementportalpreference-procurementportalpreferenceselector-invoiceunitarns

PurchaseOrderDataSourceProperty

class CfnProcurementPortalPreferencePropsMixin.PurchaseOrderDataSourceProperty(*, einvoice_delivery_document_type=None, purchase_order_data_source_type=None)

Bases: object

Specifies the source configuration for retrieving purchase order data.

Parameters:

einvoice_delivery_document_type (Optional[str]) – The type of e-invoice document that requires purchase order data.
purchase_order_data_source_type (Optional[str]) – The type of source for purchase order data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-invoicing-procurementportalpreference-purchaseorderdatasource.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_invoicing as invoicing

purchase_order_data_source_property = invoicing.CfnProcurementPortalPreferencePropsMixin.PurchaseOrderDataSourceProperty(
    einvoice_delivery_document_type="einvoiceDeliveryDocumentType",
    purchase_order_data_source_type="purchaseOrderDataSourceType"
)

Attributes

einvoice_delivery_document_type

The type of e-invoice document that requires purchase order data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-invoicing-procurementportalpreference-purchaseorderdatasource.html#cfn-invoicing-procurementportalpreference-purchaseorderdatasource-einvoicedeliverydocumenttype

purchase_order_data_source_type

The type of source for purchase order data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-invoicing-procurementportalpreference-purchaseorderdatasource.html#cfn-invoicing-procurementportalpreference-purchaseorderdatasource-purchaseorderdatasourcetype

TestEnvPreferenceProperty

class CfnProcurementPortalPreferencePropsMixin.TestEnvPreferenceProperty(*, buyer_domain=None, buyer_identifier=None, procurement_portal_instance_endpoint=None, procurement_portal_shared_secret=None, supplier_domain=None, supplier_identifier=None)

Bases: object

Configuration settings for the test environment of the procurement portal.

Parameters:

buyer_domain (Optional[str]) – The domain identifier for the buyer in the test environment.
buyer_identifier (Optional[str]) – The unique identifier for the buyer in the test environment.
procurement_portal_instance_endpoint (Optional[str]) – The endpoint URL for e-invoice delivery in the test environment.
procurement_portal_shared_secret (Optional[str]) – The shared secret for secure communication in the test environment.
supplier_domain (Optional[str]) – The domain identifier for the supplier in the test environment.
supplier_identifier (Optional[str]) – The unique identifier for the supplier in the test environment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-invoicing-procurementportalpreference-testenvpreference.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_invoicing as invoicing

test_env_preference_property = invoicing.CfnProcurementPortalPreferencePropsMixin.TestEnvPreferenceProperty(
    buyer_domain="buyerDomain",
    buyer_identifier="buyerIdentifier",
    procurement_portal_instance_endpoint="procurementPortalInstanceEndpoint",
    procurement_portal_shared_secret="procurementPortalSharedSecret",
    supplier_domain="supplierDomain",
    supplier_identifier="supplierIdentifier"
)