class CfnService (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.AppRunner.CfnService |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsapprunner#CfnService |
![]() | software.amazon.awscdk.services.apprunner.CfnService |
![]() | aws_cdk.aws_apprunner.CfnService |
![]() | aws-cdk-lib » aws_apprunner » CfnService |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
Specify an AWS App Runner service by using the AWS::AppRunner::Service
resource in an AWS CloudFormation template.
The AWS::AppRunner::Service
resource is an AWS App Runner resource type that specifies an App Runner service.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apprunner as apprunner } from 'aws-cdk-lib';
const cfnService = new apprunner.CfnService(this, 'MyCfnService', {
sourceConfiguration: {
authenticationConfiguration: {
accessRoleArn: 'accessRoleArn',
connectionArn: 'connectionArn',
},
autoDeploymentsEnabled: false,
codeRepository: {
repositoryUrl: 'repositoryUrl',
sourceCodeVersion: {
type: 'type',
value: 'value',
},
// the properties below are optional
codeConfiguration: {
configurationSource: 'configurationSource',
// the properties below are optional
codeConfigurationValues: {
runtime: 'runtime',
// the properties below are optional
buildCommand: 'buildCommand',
port: 'port',
runtimeEnvironmentSecrets: [{
name: 'name',
value: 'value',
}],
runtimeEnvironmentVariables: [{
name: 'name',
value: 'value',
}],
startCommand: 'startCommand',
},
},
sourceDirectory: 'sourceDirectory',
},
imageRepository: {
imageIdentifier: 'imageIdentifier',
imageRepositoryType: 'imageRepositoryType',
// the properties below are optional
imageConfiguration: {
port: 'port',
runtimeEnvironmentSecrets: [{
name: 'name',
value: 'value',
}],
runtimeEnvironmentVariables: [{
name: 'name',
value: 'value',
}],
startCommand: 'startCommand',
},
},
},
// the properties below are optional
autoScalingConfigurationArn: 'autoScalingConfigurationArn',
encryptionConfiguration: {
kmsKey: 'kmsKey',
},
healthCheckConfiguration: {
healthyThreshold: 123,
interval: 123,
path: 'path',
protocol: 'protocol',
timeout: 123,
unhealthyThreshold: 123,
},
instanceConfiguration: {
cpu: 'cpu',
instanceRoleArn: 'instanceRoleArn',
memory: 'memory',
},
networkConfiguration: {
egressConfiguration: {
egressType: 'egressType',
// the properties below are optional
vpcConnectorArn: 'vpcConnectorArn',
},
ingressConfiguration: {
isPubliclyAccessible: false,
},
ipAddressType: 'ipAddressType',
},
observabilityConfiguration: {
observabilityEnabled: false,
// the properties below are optional
observabilityConfigurationArn: 'observabilityConfigurationArn',
},
serviceName: 'serviceName',
tags: [{
key: 'key',
value: 'value',
}],
});
Initializer
new CfnService(scope: Construct, id: string, props: CfnServiceProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.Service Props
Construct Props
Name | Type | Description |
---|---|---|
source | IResolvable | Source | The source to deploy to the App Runner service. |
auto | string | The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service. |
encryption | IResolvable | Encryption | An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs. |
health | IResolvable | Health | The settings for the health check that AWS App Runner performs to monitor the health of the App Runner service. |
instance | IResolvable | Instance | The runtime configuration of instances (scaling units) of your service. |
network | IResolvable | Network | Configuration settings related to network traffic of the web application that the App Runner service runs. |
observability | IResolvable | Service | The observability configuration of your service. |
service | string | A name for the App Runner service. |
tags? | Cfn [] | An optional list of metadata items that you can associate with the App Runner service resource. |
sourceConfiguration
Type:
IResolvable
|
Source
The source to deploy to the App Runner service.
It can be a code or an image repository.
autoScalingConfigurationArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service.
If not provided, App Runner associates the latest revision of a default auto scaling configuration.
Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3
Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability
encryptionConfiguration?
Type:
IResolvable
|
Encryption
(optional)
An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs.
By default, App Runner uses an AWS managed key .
healthCheckConfiguration?
Type:
IResolvable
|
Health
(optional)
The settings for the health check that AWS App Runner performs to monitor the health of the App Runner service.
instanceConfiguration?
Type:
IResolvable
|
Instance
(optional)
The runtime configuration of instances (scaling units) of your service.
networkConfiguration?
Type:
IResolvable
|
Network
(optional)
Configuration settings related to network traffic of the web application that the App Runner service runs.
observabilityConfiguration?
Type:
IResolvable
|
Service
(optional)
The observability configuration of your service.
serviceName?
Type:
string
(optional)
A name for the App Runner service.
It must be unique across all the running App Runner services in your AWS account in the AWS Region .
If you don't specify a name, AWS CloudFormation generates a name for your service.
tags?
Type:
Cfn
[]
(optional)
An optional list of metadata items that you can associate with the App Runner service resource.
A tag is a key-value pair.
Properties
Name | Type | Description |
---|---|---|
attr | string | The Amazon Resource Name (ARN) of this service. |
attr | string | An ID that App Runner generated for this service. |
attr | string | A subdomain URL that App Runner generated for this service. |
attr | string | The current state of the App Runner service. These particular values mean the following. |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
logical | string | The logical ID for this CloudFormation stack element. |
node | Node | The tree node. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
source | IResolvable | Source | The source to deploy to the App Runner service. |
stack | Stack | The stack in which this element is defined. |
tags | Tag | Tag Manager which manages the tags for this resource. |
auto | string | The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service. |
encryption | IResolvable | Encryption | An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs. |
health | IResolvable | Health | The settings for the health check that AWS App Runner performs to monitor the health of the App Runner service. |
instance | IResolvable | Instance | The runtime configuration of instances (scaling units) of your service. |
network | IResolvable | Network | Configuration settings related to network traffic of the web application that the App Runner service runs. |
observability | IResolvable | Service | The observability configuration of your service. |
service | string | A name for the App Runner service. |
tags | Cfn [] | An optional list of metadata items that you can associate with the App Runner service resource. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrServiceArn
Type:
string
The Amazon Resource Name (ARN) of this service.
attrServiceId
Type:
string
An ID that App Runner generated for this service.
It's unique within the AWS Region .
attrServiceUrl
Type:
string
A subdomain URL that App Runner generated for this service.
You can use this URL to access your service web application.
attrStatus
Type:
string
The current state of the App Runner service. These particular values mean the following.
CREATE_FAILED
– The service failed to create. The failed service isn't usable, and still counts towards your service quota. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and rebuild your service usingUpdateService
.DELETE_FAILED
– The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure that all related resources are removed.
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
logicalId
Type:
string
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId)
.
node
Type:
Node
The tree node.
ref
Type:
string
Return a string that will be resolved to a CloudFormation { Ref }
for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref })
.
sourceConfiguration
Type:
IResolvable
|
Source
The source to deploy to the App Runner service.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
tags
Type:
Tag
Tag Manager which manages the tags for this resource.
autoScalingConfigurationArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service.
encryptionConfiguration?
Type:
IResolvable
|
Encryption
(optional)
An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs.
healthCheckConfiguration?
Type:
IResolvable
|
Health
(optional)
The settings for the health check that AWS App Runner performs to monitor the health of the App Runner service.
instanceConfiguration?
Type:
IResolvable
|
Instance
(optional)
The runtime configuration of instances (scaling units) of your service.
networkConfiguration?
Type:
IResolvable
|
Network
(optional)
Configuration settings related to network traffic of the web application that the App Runner service runs.
observabilityConfiguration?
Type:
IResolvable
|
Service
(optional)
The observability configuration of your service.
serviceName?
Type:
string
(optional)
A name for the App Runner service.
tagsRaw?
Type:
Cfn
[]
(optional)
An optional list of metadata items that you can associate with the App Runner service resource.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use addPropertyOverride
or prefix path
with
"Properties." (i.e. Properties.TopicName
).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal .
in the property name, prefix with a \
. In most
programming languages you will need to write this as "\\."
because the
\
itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value
argument to addOverride
will not be processed or translated
in any way. Pass raw JSON values in here with the correct capitalization
for CloudFormation. If you pass CDK classes or structs, they will be
rendered with lowercased key names, and CloudFormation will reject the
template.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT
). A list of resources that support this policy
can be found in the following link:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn
), but this can be used for future compatibility
in case there is no generated attribute.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }