Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. vpclattice
  5. Service

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.vpclattice.Service

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    A service is any software application that can run on instances containers, or serverless functions within an account or virtual private cloud (VPC).

    Create Service Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Service(name: string, args?: ServiceArgs, opts?: CustomResourceOptions);
    @overload
def Service(resource_name: str,
            args: Optional[ServiceArgs] = None,
            opts: Optional[ResourceOptions] = None)

@overload
def Service(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            auth_type: Optional[ServiceAuthType] = None,
            certificate_arn: Optional[str] = None,
            custom_domain_name: Optional[str] = None,
            dns_entry: Optional[ServiceDnsEntryArgs] = None,
            name: Optional[str] = None,
            tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewService(ctx *Context, name string, args *ServiceArgs, opts ...ResourceOption) (*Service, error)
    public Service(string name, ServiceArgs? args = null, CustomResourceOptions? opts = null)
    public Service(String name, ServiceArgs args)
public Service(String name, ServiceArgs args, CustomResourceOptions options)

    type: aws-native:vpclattice:Service
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Service Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Service resource accepts the following input properties:

    AuthType Pulumi.AwsNative.VpcLattice.ServiceAuthType
    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.
    CertificateArn string
    The Amazon Resource Name (ARN) of the certificate.
    CustomDomainName string
    The custom domain name of the service.
    DnsEntry Pulumi.AwsNative.VpcLattice.Inputs.ServiceDnsEntry
    The DNS information of the service.
    Name string

    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 List<Pulumi.AwsNative.Inputs.Tag>
    The tags for the service.
    AuthType ServiceAuthType
    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.
    CertificateArn string
    The Amazon Resource Name (ARN) of the certificate.
    CustomDomainName string
    The custom domain name of the service.
    DnsEntry ServiceDnsEntryArgs
    The DNS information of the service.
    Name string

    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 TagArgs
    The tags for the service.
    authType ServiceAuthType
    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.
    certificateArn String
    The Amazon Resource Name (ARN) of the certificate.
    customDomainName String
    The custom domain name of the service.
    dnsEntry ServiceDnsEntry
    The DNS information of the service.
    name String

    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 List<Tag>
    The tags for the service.
    authType ServiceAuthType
    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.
    certificateArn string
    The Amazon Resource Name (ARN) of the certificate.
    customDomainName string
    The custom domain name of the service.
    dnsEntry ServiceDnsEntry
    The DNS information of the service.
    name string

    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 Tag[]
    The tags for the service.
    auth_type ServiceAuthType
    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.
    certificate_arn str
    The Amazon Resource Name (ARN) of the certificate.
    custom_domain_name str
    The custom domain name of the service.
    dns_entry ServiceDnsEntryArgs
    The DNS information of the service.
    name 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 Sequence[TagArgs]
    The tags for the service.
    authType "NONE" | "AWS_IAM"
    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.
    certificateArn String
    The Amazon Resource Name (ARN) of the certificate.
    customDomainName String
    The custom domain name of the service.
    dnsEntry Property Map
    The DNS information of the service.
    name String

    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 List<Property Map>
    The tags for the service.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Service resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the service.
    AwsId string
    The ID of the service.
    CreatedAt string
    The date and time that the service was created, specified in ISO-8601 format.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedAt string
    The date and time that the service was last updated, specified in ISO-8601 format.
    Status Pulumi.AwsNative.VpcLattice.ServiceStatus
    The status of the service.
    Arn string
    The Amazon Resource Name (ARN) of the service.
    AwsId string
    The ID of the service.
    CreatedAt string
    The date and time that the service was created, specified in ISO-8601 format.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedAt string
    The date and time that the service was last updated, specified in ISO-8601 format.
    Status ServiceStatus
    The status of the service.
    arn String
    The Amazon Resource Name (ARN) of the service.
    awsId String
    The ID of the service.
    createdAt String
    The date and time that the service was created, specified in ISO-8601 format.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedAt String
    The date and time that the service was last updated, specified in ISO-8601 format.
    status ServiceStatus
    The status of the service.
    arn string
    The Amazon Resource Name (ARN) of the service.
    awsId string
    The ID of the service.
    createdAt string
    The date and time that the service was created, specified in ISO-8601 format.
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdatedAt string
    The date and time that the service was last updated, specified in ISO-8601 format.
    status ServiceStatus
    The status of the service.
    arn str
    The Amazon Resource Name (ARN) of the service.
    aws_id str
    The ID of the service.
    created_at str
    The date and time that the service was created, specified in ISO-8601 format.
    id str
    The provider-assigned unique ID for this managed resource.
    last_updated_at str
    The date and time that the service was last updated, specified in ISO-8601 format.
    status ServiceStatus
    The status of the service.
    arn String
    The Amazon Resource Name (ARN) of the service.
    awsId String
    The ID of the service.
    createdAt String
    The date and time that the service was created, specified in ISO-8601 format.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedAt String
    The date and time that the service was last updated, specified in ISO-8601 format.
    status "ACTIVE" | "CREATE_IN_PROGRESS" | "DELETE_IN_PROGRESS" | "CREATE_FAILED" | "DELETE_FAILED"
    The status of the service.

    Supporting Types

    ServiceAuthType, ServiceAuthTypeArgs

    None
    NONE
    AwsIam
    AWS_IAM
    ServiceAuthTypeNone
    NONE
    ServiceAuthTypeAwsIam
    AWS_IAM
    None
    NONE
    AwsIam
    AWS_IAM
    None
    NONE
    AwsIam
    AWS_IAM
    NONE
    NONE
    AWS_IAM
    AWS_IAM
    "NONE"
    NONE
    "AWS_IAM"
    AWS_IAM

    ServiceDnsEntry, ServiceDnsEntryArgs

    DomainName string
    The domain name of the service.
    HostedZoneId string
    The ID of the hosted zone.
    DomainName string
    The domain name of the service.
    HostedZoneId string
    The ID of the hosted zone.
    domainName String
    The domain name of the service.
    hostedZoneId String
    The ID of the hosted zone.
    domainName string
    The domain name of the service.
    hostedZoneId string
    The ID of the hosted zone.
    domain_name str
    The domain name of the service.
    hosted_zone_id str
    The ID of the hosted zone.
    domainName String
    The domain name of the service.
    hostedZoneId String
    The ID of the hosted zone.

    ServiceStatus, ServiceStatusArgs

    Active
    ACTIVE
    CreateInProgress
    CREATE_IN_PROGRESS
    DeleteInProgress
    DELETE_IN_PROGRESS
    CreateFailed
    CREATE_FAILED
    DeleteFailed
    DELETE_FAILED
    ServiceStatusActive
    ACTIVE
    ServiceStatusCreateInProgress
    CREATE_IN_PROGRESS
    ServiceStatusDeleteInProgress
    DELETE_IN_PROGRESS
    ServiceStatusCreateFailed
    CREATE_FAILED
    ServiceStatusDeleteFailed
    DELETE_FAILED
    Active
    ACTIVE
    CreateInProgress
    CREATE_IN_PROGRESS
    DeleteInProgress
    DELETE_IN_PROGRESS
    CreateFailed
    CREATE_FAILED
    DeleteFailed
    DELETE_FAILED
    Active
    ACTIVE
    CreateInProgress
    CREATE_IN_PROGRESS
    DeleteInProgress
    DELETE_IN_PROGRESS
    CreateFailed
    CREATE_FAILED
    DeleteFailed
    DELETE_FAILED
    ACTIVE
    ACTIVE
    CREATE_IN_PROGRESS
    CREATE_IN_PROGRESS
    DELETE_IN_PROGRESS
    DELETE_IN_PROGRESS
    CREATE_FAILED
    CREATE_FAILED
    DELETE_FAILED
    DELETE_FAILED
    "ACTIVE"
    ACTIVE
    "CREATE_IN_PROGRESS"
    CREATE_IN_PROGRESS
    "DELETE_IN_PROGRESS"
    DELETE_IN_PROGRESS
    "CREATE_FAILED"
    CREATE_FAILED
    "DELETE_FAILED"
    DELETE_FAILED

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native