Class CfnService

Specify an AWS App Runner service by using the AWS::AppRunner::Service resource in an AWS CloudFormation template.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnService

Implements

IInspectable

IServiceRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.AppRunner

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnService : CfnResource, IInspectable, IServiceRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnService Inherits CfnResource Implements IInspectable, IServiceRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

The AWS::AppRunner::Service resource is an AWS App Runner resource type that specifies an App Runner service.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html

CloudformationResource: AWS::AppRunner::Service

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.AppRunner;

             var cfnService = new CfnService(this, "MyCfnService", new CfnServiceProps {
                 SourceConfiguration = new SourceConfigurationProperty {
                     AuthenticationConfiguration = new AuthenticationConfigurationProperty {
                         AccessRoleArn = "accessRoleArn",
                         ConnectionArn = "connectionArn"
                     },
                     AutoDeploymentsEnabled = false,
                     CodeRepository = new CodeRepositoryProperty {
                         RepositoryUrl = "repositoryUrl",
                         SourceCodeVersion = new SourceCodeVersionProperty {
                             Type = "type",
                             Value = "value"
                         },

                         // the properties below are optional
                         CodeConfiguration = new CodeConfigurationProperty {
                             ConfigurationSource = "configurationSource",

                             // the properties below are optional
                             CodeConfigurationValues = new CodeConfigurationValuesProperty {
                                 Runtime = "runtime",

                                 // the properties below are optional
                                 BuildCommand = "buildCommand",
                                 Port = "port",
                                 RuntimeEnvironmentSecrets = new [] { new KeyValuePairProperty {
                                     Name = "name",
                                     Value = "value"
                                 } },
                                 RuntimeEnvironmentVariables = new [] { new KeyValuePairProperty {
                                     Name = "name",
                                     Value = "value"
                                 } },
                                 StartCommand = "startCommand"
                             }
                         },
                         SourceDirectory = "sourceDirectory"
                     },
                     ImageRepository = new ImageRepositoryProperty {
                         ImageIdentifier = "imageIdentifier",
                         ImageRepositoryType = "imageRepositoryType",

                         // the properties below are optional
                         ImageConfiguration = new ImageConfigurationProperty {
                             Port = "port",
                             RuntimeEnvironmentSecrets = new [] { new KeyValuePairProperty {
                                 Name = "name",
                                 Value = "value"
                             } },
                             RuntimeEnvironmentVariables = new [] { new KeyValuePairProperty {
                                 Name = "name",
                                 Value = "value"
                             } },
                             StartCommand = "startCommand"
                         }
                     }
                 },

                 // the properties below are optional
                 AutoScalingConfigurationArn = "autoScalingConfigurationArn",
                 EncryptionConfiguration = new EncryptionConfigurationProperty {
                     KmsKey = "kmsKey"
                 },
                 HealthCheckConfiguration = new HealthCheckConfigurationProperty {
                     HealthyThreshold = 123,
                     Interval = 123,
                     Path = "path",
                     Protocol = "protocol",
                     Timeout = 123,
                     UnhealthyThreshold = 123
                 },
                 InstanceConfiguration = new InstanceConfigurationProperty {
                     Cpu = "cpu",
                     InstanceRoleArn = "instanceRoleArn",
                     Memory = "memory"
                 },
                 NetworkConfiguration = new NetworkConfigurationProperty {
                     EgressConfiguration = new EgressConfigurationProperty {
                         EgressType = "egressType",

                         // the properties below are optional
                         VpcConnectorArn = "vpcConnectorArn"
                     },
                     IngressConfiguration = new IngressConfigurationProperty {
                         IsPubliclyAccessible = false
                     },
                     IpAddressType = "ipAddressType"
                 },
                 ObservabilityConfiguration = new ServiceObservabilityConfigurationProperty {
                     ObservabilityEnabled = false,

                     // the properties below are optional
                     ObservabilityConfigurationArn = "observabilityConfigurationArn"
                 },
                 ServiceName = "serviceName",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnService(Construct, string, ICfnServiceProps)

Create a new AWS::AppRunner::Service.

Properties

AttrServiceArn	The Amazon Resource Name (ARN) of this service.
AttrServiceId	An ID that App Runner generated for this service.
AttrServiceUrl	A subdomain URL that App Runner generated for this service.
AttrStatus	The current state of the App Runner service. These particular values mean the following.
AutoScalingConfigurationArn	The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Specify an AWS App Runner service by using the AWS::AppRunner::Service resource in an AWS CloudFormation template.
EncryptionConfiguration	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	The settings for the health check that AWS App Runner performs to monitor the health of the App Runner service.
InstanceConfiguration	The runtime configuration of instances (scaling units) of your service.
NetworkConfiguration	Configuration settings related to network traffic of the web application that the App Runner service runs.
ObservabilityConfiguration	The observability configuration of your service.
ServiceName	A name for the App Runner service.
ServiceRef	A reference to a Service resource.
SourceConfiguration	The source to deploy to the App Runner service.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	An optional list of metadata items that you can associate with the App Runner service resource.

Methods

ArnForService(IServiceRef)	Specify an AWS App Runner service by using the AWS::AppRunner::Service resource in an AWS CloudFormation template.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnService(object)	Checks whether the given object is a CfnService.
RenderProperties(IDictionary<string, object>)	Specify an AWS App Runner service by using the AWS::AppRunner::Service resource in an AWS CloudFormation template.

Constructors

CfnService(Construct, string, ICfnServiceProps)

Create a new AWS::AppRunner::Service.

public CfnService(Construct scope, string id, ICfnServiceProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnServiceProps

Resource properties.

Remarks

The AWS::AppRunner::Service resource is an AWS App Runner resource type that specifies an App Runner service.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html

CloudformationResource: AWS::AppRunner::Service

ExampleMetadata: fixture=_generated

Properties

AttrServiceArn

The Amazon Resource Name (ARN) of this service.

public virtual string AttrServiceArn { get; }

Property Value

string

Remarks

CloudformationAttribute: ServiceArn

AttrServiceId

An ID that App Runner generated for this service.

public virtual string AttrServiceId { get; }

Property Value

string

Remarks

It's unique within the AWS Region .

CloudformationAttribute: ServiceId

AttrServiceUrl

A subdomain URL that App Runner generated for this service.

public virtual string AttrServiceUrl { get; }

Property Value

string

Remarks

You can use this URL to access your service web application.

CloudformationAttribute: ServiceUrl

AttrStatus

The current state of the App Runner service. These particular values mean the following.

public virtual string AttrStatus { get; }

Property Value

string

Remarks

CloudformationAttribute: Status

AutoScalingConfigurationArn

The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service.

public virtual string? AutoScalingConfigurationArn { get; set; }

Property Value

string

Remarks

The AWS::AppRunner::Service resource is an AWS App Runner resource type that specifies an App Runner service.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html

CloudformationResource: AWS::AppRunner::Service

ExampleMetadata: fixture=_generated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

The AWS::AppRunner::Service resource is an AWS App Runner resource type that specifies an App Runner service.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html

CloudformationResource: AWS::AppRunner::Service

ExampleMetadata: fixture=_generated

CfnProperties

Specify an AWS App Runner service by using the AWS::AppRunner::Service resource in an AWS CloudFormation template.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

The AWS::AppRunner::Service resource is an AWS App Runner resource type that specifies an App Runner service.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html

CloudformationResource: AWS::AppRunner::Service

ExampleMetadata: fixture=_generated

EncryptionConfiguration

An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs.

public virtual object? EncryptionConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnService.IEncryptionConfigurationProperty

HealthCheckConfiguration

The settings for the health check that AWS App Runner performs to monitor the health of the App Runner service.

public virtual object? HealthCheckConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnService.IHealthCheckConfigurationProperty

InstanceConfiguration

The runtime configuration of instances (scaling units) of your service.

public virtual object? InstanceConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnService.IInstanceConfigurationProperty

NetworkConfiguration

Configuration settings related to network traffic of the web application that the App Runner service runs.

public virtual object? NetworkConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnService.INetworkConfigurationProperty

ObservabilityConfiguration

The observability configuration of your service.

public virtual object? ObservabilityConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnService.IServiceObservabilityConfigurationProperty

ServiceName

A name for the App Runner service.

public virtual string? ServiceName { get; set; }

Property Value

string

Remarks

The AWS::AppRunner::Service resource is an AWS App Runner resource type that specifies an App Runner service.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html

CloudformationResource: AWS::AppRunner::Service

ExampleMetadata: fixture=_generated

ServiceRef

A reference to a Service resource.

public virtual IServiceReference ServiceRef { get; }

Property Value

IServiceReference

Remarks

The AWS::AppRunner::Service resource is an AWS App Runner resource type that specifies an App Runner service.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html

CloudformationResource: AWS::AppRunner::Service

ExampleMetadata: fixture=_generated

SourceConfiguration

The source to deploy to the App Runner service.

public virtual object SourceConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnService.ISourceConfigurationProperty

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

The AWS::AppRunner::Service resource is an AWS App Runner resource type that specifies an App Runner service.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html

CloudformationResource: AWS::AppRunner::Service

ExampleMetadata: fixture=_generated

TagsRaw

An optional list of metadata items that you can associate with the App Runner service resource.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

The AWS::AppRunner::Service resource is an AWS App Runner resource type that specifies an App Runner service.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html

CloudformationResource: AWS::AppRunner::Service

ExampleMetadata: fixture=_generated

Methods

ArnForService(IServiceRef)

Specify an AWS App Runner service by using the AWS::AppRunner::Service resource in an AWS CloudFormation template.

public static string ArnForService(IServiceRef resource)

Parameters

resource IServiceRef

Returns

string

Remarks

The AWS::AppRunner::Service resource is an AWS App Runner resource type that specifies an App Runner service.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html

CloudformationResource: AWS::AppRunner::Service

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.AppRunner;

             var cfnService = new CfnService(this, "MyCfnService", new CfnServiceProps {
                 SourceConfiguration = new SourceConfigurationProperty {
                     AuthenticationConfiguration = new AuthenticationConfigurationProperty {
                         AccessRoleArn = "accessRoleArn",
                         ConnectionArn = "connectionArn"
                     },
                     AutoDeploymentsEnabled = false,
                     CodeRepository = new CodeRepositoryProperty {
                         RepositoryUrl = "repositoryUrl",
                         SourceCodeVersion = new SourceCodeVersionProperty {
                             Type = "type",
                             Value = "value"
                         },

                         // the properties below are optional
                         CodeConfiguration = new CodeConfigurationProperty {
                             ConfigurationSource = "configurationSource",

                             // the properties below are optional
                             CodeConfigurationValues = new CodeConfigurationValuesProperty {
                                 Runtime = "runtime",

                                 // the properties below are optional
                                 BuildCommand = "buildCommand",
                                 Port = "port",
                                 RuntimeEnvironmentSecrets = new [] { new KeyValuePairProperty {
                                     Name = "name",
                                     Value = "value"
                                 } },
                                 RuntimeEnvironmentVariables = new [] { new KeyValuePairProperty {
                                     Name = "name",
                                     Value = "value"
                                 } },
                                 StartCommand = "startCommand"
                             }
                         },
                         SourceDirectory = "sourceDirectory"
                     },
                     ImageRepository = new ImageRepositoryProperty {
                         ImageIdentifier = "imageIdentifier",
                         ImageRepositoryType = "imageRepositoryType",

                         // the properties below are optional
                         ImageConfiguration = new ImageConfigurationProperty {
                             Port = "port",
                             RuntimeEnvironmentSecrets = new [] { new KeyValuePairProperty {
                                 Name = "name",
                                 Value = "value"
                             } },
                             RuntimeEnvironmentVariables = new [] { new KeyValuePairProperty {
                                 Name = "name",
                                 Value = "value"
                             } },
                             StartCommand = "startCommand"
                         }
                     }
                 },

                 // the properties below are optional
                 AutoScalingConfigurationArn = "autoScalingConfigurationArn",
                 EncryptionConfiguration = new EncryptionConfigurationProperty {
                     KmsKey = "kmsKey"
                 },
                 HealthCheckConfiguration = new HealthCheckConfigurationProperty {
                     HealthyThreshold = 123,
                     Interval = 123,
                     Path = "path",
                     Protocol = "protocol",
                     Timeout = 123,
                     UnhealthyThreshold = 123
                 },
                 InstanceConfiguration = new InstanceConfigurationProperty {
                     Cpu = "cpu",
                     InstanceRoleArn = "instanceRoleArn",
                     Memory = "memory"
                 },
                 NetworkConfiguration = new NetworkConfigurationProperty {
                     EgressConfiguration = new EgressConfigurationProperty {
                         EgressType = "egressType",

                         // the properties below are optional
                         VpcConnectorArn = "vpcConnectorArn"
                     },
                     IngressConfiguration = new IngressConfigurationProperty {
                         IsPubliclyAccessible = false
                     },
                     IpAddressType = "ipAddressType"
                 },
                 ObservabilityConfiguration = new ServiceObservabilityConfigurationProperty {
                     ObservabilityEnabled = false,

                     // the properties below are optional
                     ObservabilityConfigurationArn = "observabilityConfigurationArn"
                 },
                 ServiceName = "serviceName",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

The AWS::AppRunner::Service resource is an AWS App Runner resource type that specifies an App Runner service.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html

CloudformationResource: AWS::AppRunner::Service

ExampleMetadata: fixture=_generated

IsCfnService(object)

Checks whether the given object is a CfnService.

public static bool IsCfnService(object x)

Parameters

x object

Returns

bool

Remarks

The AWS::AppRunner::Service resource is an AWS App Runner resource type that specifies an App Runner service.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html

CloudformationResource: AWS::AppRunner::Service

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Specify an AWS App Runner service by using the AWS::AppRunner::Service resource in an AWS CloudFormation template.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

The AWS::AppRunner::Service resource is an AWS App Runner resource type that specifies an App Runner service.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html

CloudformationResource: AWS::AppRunner::Service

ExampleMetadata: fixture=_generated

Implements

IInspectable

IServiceRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable