create_ingress_point
¶
create_ingress_point(
ingress_point_name: IngressPointName,
type: IngressPointType,
rule_set_id: RuleSetId,
traffic_policy_id: TrafficPolicyId,
*,
config_overrides: Optional[MailManagerClientConfig] = None,
client_token: Optional[IdempotencyToken] = None,
ingress_point_configuration: Optional[IngressPointConfiguration] = None,
network_configuration: Optional[NetworkConfiguration] = None,
tls_policy: Optional[TlsPolicy] = None,
tags: Optional[TagList] = None,
) -> CreateIngressPointResponse
Provision a new ingress endpoint resource.
Parameters:
-
client_token(Optional[IdempotencyToken], default:None) –A unique token that Amazon SES uses to recognize subsequent retries of the same request.
-
ingress_point_name(IngressPointName) –A user friendly name for an ingress endpoint resource.
-
type(IngressPointType) –The type of the ingress endpoint to create.
-
rule_set_id(RuleSetId) –The identifier of an existing rule set that you attach to an ingress endpoint resource.
-
traffic_policy_id(TrafficPolicyId) –The identifier of an existing traffic policy that you attach to an ingress endpoint resource.
-
ingress_point_configuration(Optional[IngressPointConfiguration], default:None) –If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.
-
network_configuration(Optional[NetworkConfiguration], default:None) –Specifies the network configuration for the ingress point. This allows you to create an IPv4-only, Dual-Stack, or PrivateLink type of ingress point. If not specified, the default network type is IPv4-only.
-
tls_policy(Optional[TlsPolicy], default:None) –The Transport Layer Security (TLS) policy for the ingress point. The FIPS value is only valid in US and Canada regions.
-
tags(Optional[TagList], default:None) –The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
Raises:
-
ConflictException–The request configuration has conflicts. For details, see the accompanying error message.
-
ServiceQuotaExceededException–Occurs when an operation exceeds a predefined service quota or limit.
-
ValidationException–The request validation has failed. For details, see the accompanying error message.
-
UnknownServiceError–The service returned an error code this client does not model.
Examples:
Create Open IngressPoint
>>> client.create_ingress_point(ingress_point_name='ingressPointName', type='OPEN', rule_set_id='rs-12345', traffic_policy_id='tp-12345', tags=[{'Key': 'key', 'Value': 'value'}])
Create Auth IngressPoint with Password
>>> client.create_ingress_point(ingress_point_name='ingressPointName', type='AUTH', rule_set_id='rs-12345', traffic_policy_id='tp-12345', ingress_point_configuration={'SmtpPassword': 'smtpPassword'}, tags=[{'Key': 'key', 'Value': 'value'}])
Create Auth IngressPoint with SecretsManager Secret
>>> client.create_ingress_point(ingress_point_name='ingressPointName', type='AUTH', rule_set_id='rs-12345', traffic_policy_id='tp-12345', ingress_point_configuration={'SecretArn': 'arn:aws:secretsmanager:us-west-2:123456789012:secret:abcde'}, tags=[{'Key': 'key', 'Value': 'value'}])
Source code in docs_src/capo_mailmanager/_services/mail_manager.py
2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 | |