CfnServiceProps

class aws_cdk.aws_vpclattice.CfnServiceProps(*, auth_type=None, certificate_arn=None, custom_domain_name=None, dns_entry=None, name=None, tags=None)

Bases: object

Properties for defining a CfnService.

Parameters:

auth_type (Optional[str]) – The type of IAM policy. - NONE : The resource does not use an IAM policy. This is the default. - AWS_IAM : The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required. Default: - “NONE”
certificate_arn (Optional[str]) – The Amazon Resource Name (ARN) of the certificate.
custom_domain_name (Optional[str]) – The custom domain name of the service.
dns_entry (Union[IResolvable, DnsEntryProperty, Dict[str, Any], None]) – The DNS information of the service.
name (Optional[str]) – The name of the service. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can’t use a hyphen as the first or last character, or immediately after another hyphen. If you don’t specify a name, CloudFormation generates one. However, if you specify a name, and later want to replace the resource, you must specify a new name.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags for the service.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.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 import aws_vpclattice as vpclattice

cfn_service_props = vpclattice.CfnServiceProps(
    auth_type="authType",
    certificate_arn="certificateArn",
    custom_domain_name="customDomainName",
    dns_entry=vpclattice.CfnService.DnsEntryProperty(
        domain_name="domainName",
        hosted_zone_id="hostedZoneId"
    ),
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

auth_type

The type of IAM policy.

NONE : The resource does not use an IAM policy. This is the default.
AWS_IAM : The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.

Default:

“NONE”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html#cfn-vpclattice-service-authtype

certificate_arn

The Amazon Resource Name (ARN) of the certificate.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html#cfn-vpclattice-service-certificatearn

custom_domain_name

The custom domain name of the service.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html#cfn-vpclattice-service-customdomainname

dns_entry

The DNS information of the service.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html#cfn-vpclattice-service-dnsentry

name

The name of the service.

The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can’t use a hyphen as the first or last character, or immediately after another hyphen.

If you don’t specify a name, CloudFormation generates one. However, if you specify a name, and later want to replace the resource, you must specify a new name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html#cfn-vpclattice-service-name

tags

The tags for the service.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-service.html#cfn-vpclattice-service-tags