AWS Native is in preview. AWS Classic is fully supported.
aws-native.vpclattice.Service
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
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:
- Auth
Type Pulumi.Aws Native. Vpc Lattice. Service 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.
- Certificate
Arn string - The Amazon Resource Name (ARN) of the certificate.
- Custom
Domain stringName - The custom domain name of the service.
- Dns
Entry Pulumi.Aws Native. Vpc Lattice. Inputs. Service Dns Entry - 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.
- List<Pulumi.
Aws Native. Inputs. Tag> - The tags for the service.
- Auth
Type ServiceAuth 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.
- Certificate
Arn string - The Amazon Resource Name (ARN) of the certificate.
- Custom
Domain stringName - The custom domain name of the service.
- Dns
Entry ServiceDns Entry Args - 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.
- Tag
Args - The tags for the service.
- auth
Type ServiceAuth 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.
- certificate
Arn String - The Amazon Resource Name (ARN) of the certificate.
- custom
Domain StringName - The custom domain name of the service.
- dns
Entry ServiceDns Entry - 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.
- List<Tag>
- The tags for the service.
- auth
Type ServiceAuth 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.
- certificate
Arn string - The Amazon Resource Name (ARN) of the certificate.
- custom
Domain stringName - The custom domain name of the service.
- dns
Entry ServiceDns Entry - 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.
- Tag[]
- The tags for the service.
- auth_
type ServiceAuth 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.
- certificate_
arn str - The Amazon Resource Name (ARN) of the certificate.
- custom_
domain_ strname - The custom domain name of the service.
- dns_
entry ServiceDns Entry Args - 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.
- Sequence[Tag
Args] - The tags for the service.
- auth
Type "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.
- certificate
Arn String - The Amazon Resource Name (ARN) of the certificate.
- custom
Domain StringName - The custom domain name of the service.
- dns
Entry 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.
- 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.
- Aws
Id string - The ID of the service.
- Created
At 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.
- Last
Updated stringAt - The date and time that the service was last updated, specified in ISO-8601 format.
- Status
Pulumi.
Aws Native. Vpc Lattice. Service Status - The status of the service.
- Arn string
- The Amazon Resource Name (ARN) of the service.
- Aws
Id string - The ID of the service.
- Created
At 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.
- Last
Updated stringAt - The date and time that the service was last updated, specified in ISO-8601 format.
- Status
Service
Status - The status of the service.
- arn String
- The Amazon Resource Name (ARN) of the service.
- aws
Id String - The ID of the service.
- created
At 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.
- last
Updated StringAt - The date and time that the service was last updated, specified in ISO-8601 format.
- status
Service
Status - The status of the service.
- arn string
- The Amazon Resource Name (ARN) of the service.
- aws
Id string - The ID of the service.
- created
At 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.
- last
Updated stringAt - The date and time that the service was last updated, specified in ISO-8601 format.
- status
Service
Status - 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_ strat - The date and time that the service was last updated, specified in ISO-8601 format.
- status
Service
Status - The status of the service.
- arn String
- The Amazon Resource Name (ARN) of the service.
- aws
Id String - The ID of the service.
- created
At 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.
- last
Updated StringAt - 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
- Aws
Iam - AWS_IAM
- Service
Auth Type None - NONE
- Service
Auth Type Aws Iam - AWS_IAM
- None
- NONE
- Aws
Iam - AWS_IAM
- None
- NONE
- Aws
Iam - AWS_IAM
- NONE
- NONE
- AWS_IAM
- AWS_IAM
- "NONE"
- NONE
- "AWS_IAM"
- AWS_IAM
ServiceDnsEntry, ServiceDnsEntryArgs
- Domain
Name string - The domain name of the service.
- Hosted
Zone stringId - The ID of the hosted zone.
- Domain
Name string - The domain name of the service.
- Hosted
Zone stringId - The ID of the hosted zone.
- domain
Name String - The domain name of the service.
- hosted
Zone StringId - The ID of the hosted zone.
- domain
Name string - The domain name of the service.
- hosted
Zone stringId - The ID of the hosted zone.
- domain_
name str - The domain name of the service.
- hosted_
zone_ strid - The ID of the hosted zone.
- domain
Name String - The domain name of the service.
- hosted
Zone StringId - The ID of the hosted zone.
ServiceStatus, ServiceStatusArgs
- Active
- ACTIVE
- Create
In Progress - CREATE_IN_PROGRESS
- Delete
In Progress - DELETE_IN_PROGRESS
- Create
Failed - CREATE_FAILED
- Delete
Failed - DELETE_FAILED
- Service
Status Active - ACTIVE
- Service
Status Create In Progress - CREATE_IN_PROGRESS
- Service
Status Delete In Progress - DELETE_IN_PROGRESS
- Service
Status Create Failed - CREATE_FAILED
- Service
Status 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
- 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
- "ACTIVE"
- ACTIVE
- "CREATE_IN_PROGRESS"
- CREATE_IN_PROGRESS
- "DELETE_IN_PROGRESS"
- DELETE_IN_PROGRESS
- "CREATE_FAILED"
- CREATE_FAILED
- "DELETE_FAILED"
- DELETE_FAILED
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.