Class DeploymentIdentities

(experimental) Deployment identities are the class of roles to be assumed by the CDK when deploying the App.

Inheritance

object

DeploymentIdentities

Namespace: Amazon.CDK.AppStagingSynthesizer.Alpha

Assembly: Amazon.CDK.AppStagingSynthesizer.Alpha.dll

Syntax (csharp)

public class DeploymentIdentities : DeputyBase

Syntax (vb)

Public Class DeploymentIdentities Inherits DeputyBase

Remarks

Stability: Experimental

ExampleMetadata: infused

Examples

using Amazon.CDK.AWS.S3;


             var app = new App(new AppProps {
                 DefaultStackSynthesizer = AppStagingSynthesizer.DefaultResources(new DefaultResourcesOptions {
                     AppId = "my-app-id",
                     StagingBucketEncryption = BucketEncryption.S3_MANAGED,

                     // The following line is optional. By default it is assumed you have bootstrapped in the same
                     // region(s) as the stack(s) you are deploying.
                     DeploymentIdentities = DeploymentIdentities.DefaultBootstrapRoles(new DefaultBootstrapRolesOptions { BootstrapRegion = "us-east-1" })
                 })
             });

Synopsis

Properties

CloudFormationExecutionRole	(experimental) CloudFormation Execution Role.
DeploymentRole	(experimental) Deployment Action Role.
LookupRole	(experimental) Lookup Role.

Methods

CliCredentials()	(experimental) Use CLI credentials for all deployment identities.
DefaultBootstrapRoles(IDefaultBootstrapRolesOptions?)	(experimental) Use the Roles that have been created by the default bootstrap stack.
SpecifyRoles(IBootstrapRoles)	(experimental) Specify your own roles for all deployment identities.

Properties

CloudFormationExecutionRole

(experimental) CloudFormation Execution Role.

public virtual BootstrapRole? CloudFormationExecutionRole { get; }

Property Value

BootstrapRole

Remarks

Stability: Experimental

DeploymentRole

(experimental) Deployment Action Role.

public virtual BootstrapRole? DeploymentRole { get; }

Property Value

BootstrapRole

Remarks

Stability: Experimental

LookupRole

(experimental) Lookup Role.

public virtual BootstrapRole? LookupRole { get; }

Property Value

BootstrapRole

Remarks

Default: - use bootstrapped role

Stability: Experimental

Methods

CliCredentials()

(experimental) Use CLI credentials for all deployment identities.

public static DeploymentIdentities CliCredentials()

Returns

DeploymentIdentities

Remarks

Stability: Experimental

DefaultBootstrapRoles(IDefaultBootstrapRolesOptions?)

(experimental) Use the Roles that have been created by the default bootstrap stack.

public static DeploymentIdentities DefaultBootstrapRoles(IDefaultBootstrapRolesOptions? options = null)

Parameters

options IDefaultBootstrapRolesOptions

Returns

DeploymentIdentities

Remarks

Stability: Experimental

SpecifyRoles(IBootstrapRoles)

(experimental) Specify your own roles for all deployment identities.

public static DeploymentIdentities SpecifyRoles(IBootstrapRoles roles)

Parameters

roles IBootstrapRoles

Returns

DeploymentIdentities

Remarks

These roles must already exist.

Stability: Experimental