CloudFormationExtensions.WithReference Method

Reference

Definition

Namespace:: Aspire.Hosting

Assembly:: Aspire.Hosting.AWS.dll

Package:: Aspire.Hosting.AWS v8.2.2-preview.1.24521.5

Package:: Aspire.Hosting.AWS v9.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

WithReference(IResourceBuilder<ICloudFormationStackResource>, IAmazonCloudFormation)	Override the CloudFormation service client the ICloudFormationStackResource would create to interact with the CloudFormation service. This can be used for pointing the CloudFormation service client to a non-standard CloudFormation endpoint like an emulator.
WithReference(IResourceBuilder<ICloudFormationStackResource>, IAWSSDKConfig)	The AWS SDK service client configuration used to create the CloudFormation service client.
WithReference(IResourceBuilder<ICloudFormationTemplateResource>, IAmazonCloudFormation)	Override the CloudFormation service client the ICloudFormationTemplateResource would create to interact with the CloudFormation service. This can be used for pointing the CloudFormation service client to a non-standard CloudFormation endpoint like an emulator.
WithReference(IResourceBuilder<ICloudFormationTemplateResource>, IAWSSDKConfig)	The AWS SDK service client configuration used to create the CloudFormation service client.
WithReference<TDestination>(IResourceBuilder<TDestination>, IAmazonCloudFormation)	Override the CloudFormation service client the ICloudFormationStackResource would create to interact with the CloudFormation service. This can be used for pointing the CloudFormation service client to a non-standard CloudFormation endpoint like an emulator.
WithReference<TDestination>(IResourceBuilder<TDestination>, IAWSSDKConfig)	The AWS SDK service client configuration used to create the CloudFormation service client.
WithReference<TDestination>(IResourceBuilder<TDestination>, IResourceBuilder<ICloudFormationResource>, String)	Add a reference of a CloudFormations stack to a project. The output parameters of the CloudFormation stack are added to the project IConfiguration.

WithReference(IResourceBuilder<ICloudFormationStackResource>, IAmazonCloudFormation)

Source:: CloudFormationExtensions.cs

Override the CloudFormation service client the ICloudFormationStackResource would create to interact with the CloudFormation service. This can be used for pointing the CloudFormation service client to a non-standard CloudFormation endpoint like an emulator.

public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.AWS.CloudFormation.ICloudFormationStackResource> WithReference(this Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.AWS.CloudFormation.ICloudFormationStackResource> builder, Amazon.CloudFormation.IAmazonCloudFormation cloudFormationClient);

static member WithReference : Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.AWS.CloudFormation.ICloudFormationStackResource> * Amazon.CloudFormation.IAmazonCloudFormation -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.AWS.CloudFormation.ICloudFormationStackResource>

<Extension()>
Public Function WithReference (builder As IResourceBuilder(Of ICloudFormationStackResource), cloudFormationClient As IAmazonCloudFormation) As IResourceBuilder(Of ICloudFormationStackResource)

Parameters

builder: IResourceBuilder<ICloudFormationStackResource>

cloudFormationClient: Amazon.CloudFormation.IAmazonCloudFormation

The AWS CloudFormation service client.

Returns

IResourceBuilder<ICloudFormationStackResource>

Applies to

.NET Aspire 8.0.0

Produit	Versions
.NET Aspire	8.0.0

WithReference(IResourceBuilder<ICloudFormationStackResource>, IAWSSDKConfig)

Source:: CloudFormationExtensions.cs

The AWS SDK service client configuration used to create the CloudFormation service client.

public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.AWS.CloudFormation.ICloudFormationStackResource> WithReference(this Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.AWS.CloudFormation.ICloudFormationStackResource> builder, Aspire.Hosting.AWS.IAWSSDKConfig awsSdkConfig);

static member WithReference : Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.AWS.CloudFormation.ICloudFormationStackResource> * Aspire.Hosting.AWS.IAWSSDKConfig -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.AWS.CloudFormation.ICloudFormationStackResource>

<Extension()>
Public Function WithReference (builder As IResourceBuilder(Of ICloudFormationStackResource), awsSdkConfig As IAWSSDKConfig) As IResourceBuilder(Of ICloudFormationStackResource)

Parameters

builder: IResourceBuilder<ICloudFormationStackResource>

awsSdkConfig: IAWSSDKConfig

The name of the AWS credential profile.

Returns

IResourceBuilder<ICloudFormationStackResource>

Applies to

.NET Aspire 8.0.0

Produit	Versions
.NET Aspire	8.0.0

WithReference(IResourceBuilder<ICloudFormationTemplateResource>, IAmazonCloudFormation)

Source:: CloudFormationExtensions.cs

Override the CloudFormation service client the ICloudFormationTemplateResource would create to interact with the CloudFormation service. This can be used for pointing the CloudFormation service client to a non-standard CloudFormation endpoint like an emulator.

public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.AWS.CloudFormation.ICloudFormationTemplateResource> WithReference(this Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.AWS.CloudFormation.ICloudFormationTemplateResource> builder, Amazon.CloudFormation.IAmazonCloudFormation cloudFormationClient);

static member WithReference : Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.AWS.CloudFormation.ICloudFormationTemplateResource> * Amazon.CloudFormation.IAmazonCloudFormation -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.AWS.CloudFormation.ICloudFormationTemplateResource>

<Extension()>
Public Function WithReference (builder As IResourceBuilder(Of ICloudFormationTemplateResource), cloudFormationClient As IAmazonCloudFormation) As IResourceBuilder(Of ICloudFormationTemplateResource)

Parameters

builder: IResourceBuilder<ICloudFormationTemplateResource>

cloudFormationClient: Amazon.CloudFormation.IAmazonCloudFormation

The AWS CloudFormation service client.

Returns

IResourceBuilder<ICloudFormationTemplateResource>

Applies to

.NET Aspire 8.0.0

Produit	Versions
.NET Aspire	8.0.0

WithReference(IResourceBuilder<ICloudFormationTemplateResource>, IAWSSDKConfig)

Source:: CloudFormationExtensions.cs

The AWS SDK service client configuration used to create the CloudFormation service client.

public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.AWS.CloudFormation.ICloudFormationTemplateResource> WithReference(this Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.AWS.CloudFormation.ICloudFormationTemplateResource> builder, Aspire.Hosting.AWS.IAWSSDKConfig awsSdkConfig);

static member WithReference : Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.AWS.CloudFormation.ICloudFormationTemplateResource> * Aspire.Hosting.AWS.IAWSSDKConfig -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.AWS.CloudFormation.ICloudFormationTemplateResource>

<Extension()>
Public Function WithReference (builder As IResourceBuilder(Of ICloudFormationTemplateResource), awsSdkConfig As IAWSSDKConfig) As IResourceBuilder(Of ICloudFormationTemplateResource)

Parameters

builder: IResourceBuilder<ICloudFormationTemplateResource>

awsSdkConfig: IAWSSDKConfig

The name of the AWS credential profile.

Returns

IResourceBuilder<ICloudFormationTemplateResource>

Applies to

.NET Aspire 8.0.0

Produit	Versions
.NET Aspire	8.0.0

WithReference<TDestination>(IResourceBuilder<TDestination>, IAmazonCloudFormation)

Source:: CloudFormationExtensions.cs

public static Aspire.Hosting.ApplicationModel.IResourceBuilder<TDestination> WithReference<TDestination>(this Aspire.Hosting.ApplicationModel.IResourceBuilder<TDestination> builder, Amazon.CloudFormation.IAmazonCloudFormation cloudFormationClient) where TDestination : Aspire.Hosting.AWS.CloudFormation.ICloudFormationResource;

static member WithReference : Aspire.Hosting.ApplicationModel.IResourceBuilder<'Destination (requires 'Destination :> Aspire.Hosting.AWS.CloudFormation.ICloudFormationResource)> * Amazon.CloudFormation.IAmazonCloudFormation -> Aspire.Hosting.ApplicationModel.IResourceBuilder<'Destination (requires 'Destination :> Aspire.Hosting.AWS.CloudFormation.ICloudFormationResource)> (requires 'Destination :> Aspire.Hosting.AWS.CloudFormation.ICloudFormationResource)

<Extension()>
Public Function WithReference(Of TDestination As ICloudFormationResource) (builder As IResourceBuilder(Of TDestination), cloudFormationClient As IAmazonCloudFormation) As IResourceBuilder(Of TDestination)

Type Parameters

TDestination

Parameters

builder: IResourceBuilder<TDestination>

cloudFormationClient: Amazon.CloudFormation.IAmazonCloudFormation

The AWS CloudFormation service client.

Returns

IResourceBuilder<TDestination>

Applies to

.NET Aspire 9.0.0

Produit	Versions
.NET Aspire	9.0.0

WithReference<TDestination>(IResourceBuilder<TDestination>, IAWSSDKConfig)

Source:: CloudFormationExtensions.cs

The AWS SDK service client configuration used to create the CloudFormation service client.

public static Aspire.Hosting.ApplicationModel.IResourceBuilder<TDestination> WithReference<TDestination>(this Aspire.Hosting.ApplicationModel.IResourceBuilder<TDestination> builder, Aspire.Hosting.AWS.IAWSSDKConfig awsSdkConfig) where TDestination : Aspire.Hosting.AWS.CloudFormation.ICloudFormationResource;

static member WithReference : Aspire.Hosting.ApplicationModel.IResourceBuilder<'Destination (requires 'Destination :> Aspire.Hosting.AWS.CloudFormation.ICloudFormationResource)> * Aspire.Hosting.AWS.IAWSSDKConfig -> Aspire.Hosting.ApplicationModel.IResourceBuilder<'Destination (requires 'Destination :> Aspire.Hosting.AWS.CloudFormation.ICloudFormationResource)> (requires 'Destination :> Aspire.Hosting.AWS.CloudFormation.ICloudFormationResource)

<Extension()>
Public Function WithReference(Of TDestination As ICloudFormationResource) (builder As IResourceBuilder(Of TDestination), awsSdkConfig As IAWSSDKConfig) As IResourceBuilder(Of TDestination)

Type Parameters

TDestination

Parameters

builder: IResourceBuilder<TDestination>

awsSdkConfig: IAWSSDKConfig

The name of the AWS credential profile.

Returns

IResourceBuilder<TDestination>

Applies to

.NET Aspire 9.0.0

Produit	Versions
.NET Aspire	9.0.0

WithReference<TDestination>(IResourceBuilder<TDestination>, IResourceBuilder<ICloudFormationResource>, String)

Source:: CloudFormationExtensions.cs

Source:: CloudFormationExtensions.cs

Add a reference of a CloudFormations stack to a project. The output parameters of the CloudFormation stack are added to the project IConfiguration.

public static Aspire.Hosting.ApplicationModel.IResourceBuilder<TDestination> WithReference<TDestination>(this Aspire.Hosting.ApplicationModel.IResourceBuilder<TDestination> builder, Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.AWS.CloudFormation.ICloudFormationResource> cloudFormationResourceBuilder, string configSection = "AWS::Resources") where TDestination : Aspire.Hosting.ApplicationModel.IResourceWithEnvironment;

public static Aspire.Hosting.ApplicationModel.IResourceBuilder<TDestination> WithReference<TDestination>(this Aspire.Hosting.ApplicationModel.IResourceBuilder<TDestination> builder, Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.AWS.CloudFormation.ICloudFormationResource> cloudFormationResourceBuilder, string configSection = "AWS:Resources") where TDestination : Aspire.Hosting.ApplicationModel.IResourceWithEnvironment;

static member WithReference : Aspire.Hosting.ApplicationModel.IResourceBuilder<'Destination (requires 'Destination :> Aspire.Hosting.ApplicationModel.IResourceWithEnvironment)> * Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.AWS.CloudFormation.ICloudFormationResource> * string -> Aspire.Hosting.ApplicationModel.IResourceBuilder<'Destination (requires 'Destination :> Aspire.Hosting.ApplicationModel.IResourceWithEnvironment)> (requires 'Destination :> Aspire.Hosting.ApplicationModel.IResourceWithEnvironment)

<Extension()>
Public Function WithReference(Of TDestination As IResourceWithEnvironment) (builder As IResourceBuilder(Of TDestination), cloudFormationResourceBuilder As IResourceBuilder(Of ICloudFormationResource), Optional configSection As String = "AWS::Resources") As IResourceBuilder(Of TDestination)

<Extension()>
Public Function WithReference(Of TDestination As IResourceWithEnvironment) (builder As IResourceBuilder(Of TDestination), cloudFormationResourceBuilder As IResourceBuilder(Of ICloudFormationResource), Optional configSection As String = "AWS:Resources") As IResourceBuilder(Of TDestination)

Type Parameters

TDestination

Parameters

builder: IResourceBuilder<TDestination>

cloudFormationResourceBuilder: IResourceBuilder<ICloudFormationResource>

The CloudFormation resource.

configSection: String

The config section in IConfiguration to add the output parameters.

Returns

IResourceBuilder<TDestination>

Applies to

.NET Aspire 9.0.0 et .NET Aspire 8.0.0

Produit	Versions
.NET Aspire	8.0.0, 9.0.0

Partage via

CloudFormationExtensions.WithReference Method

Definition

Overloads

WithReference(IResourceBuilder<ICloudFormationStackResource>, IAmazonCloudFormation)

Parameters

Returns

Applies to

WithReference(IResourceBuilder<ICloudFormationStackResource>, IAWSSDKConfig)

Parameters

Returns

Applies to

WithReference(IResourceBuilder<ICloudFormationTemplateResource>, IAmazonCloudFormation)

Parameters

Returns

Applies to

WithReference(IResourceBuilder<ICloudFormationTemplateResource>, IAWSSDKConfig)

Parameters

Returns

Applies to

WithReference<TDestination>(IResourceBuilder<TDestination>, IAmazonCloudFormation)

Type Parameters

Parameters

Returns

Applies to

WithReference<TDestination>(IResourceBuilder<TDestination>, IAWSSDKConfig)

Type Parameters

Parameters

Returns

Applies to

WithReference<TDestination>(IResourceBuilder<TDestination>, IResourceBuilder<ICloudFormationResource>, String)

Type Parameters

Parameters

Returns

Applies to

Commentaires

Ressources supplémentaires