Interface CfnCapability.IArgoCdProperty

Configuration settings for an Argo CD capability.

Namespace: Amazon.CDK.AWS.EKS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnCapability.IArgoCdProperty

Syntax (vb)

Public Interface CfnCapability.IArgoCdProperty

Remarks

This includes the Kubernetes namespace, IAM Identity Center integration, RBAC role mappings, and network access configuration.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-argocd.html

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.EKS;

             var argoCdProperty = new ArgoCdProperty {
                 AwsIdc = new AwsIdcProperty {
                     IdcInstanceArn = "idcInstanceArn",

                     // the properties below are optional
                     IdcManagedApplicationArn = "idcManagedApplicationArn",
                     IdcRegion = "idcRegion"
                 },

                 // the properties below are optional
                 Namespace = "namespace",
                 NetworkAccess = new NetworkAccessProperty {
                     VpceIds = new [] { "vpceIds" }
                 },
                 RbacRoleMappings = new [] { new ArgoCdRoleMappingProperty {
                     Identities = new [] { new SsoIdentityProperty {
                         Id = "id",
                         Type = "type"
                     } },
                     Role = "role"
                 } },
                 ServerUrl = "serverUrl"
             };

Synopsis

Properties

AwsIdc	Configuration for integrating Argo CD with IAM Identity Center.
Namespace	The Kubernetes namespace where Argo CD resources will be created.
NetworkAccess	Configuration for network access to the Argo CD capability's managed API server endpoint.
RbacRoleMappings	A list of role mappings that define which IAM Identity Center users or groups have which Argo CD roles.
ServerUrl	The URL of the Argo CD server.

Properties

AwsIdc

Configuration for integrating Argo CD with IAM Identity Center.

object AwsIdc { get; }

Property Value

object

Remarks

This allows you to use your organization's identity provider for authentication to Argo CD.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-argocd.html#cfn-eks-capability-argocd-awsidc

Type union: either IResolvable or CfnCapability.IAwsIdcProperty

Namespace

The Kubernetes namespace where Argo CD resources will be created.

string? Namespace { get; }

Property Value

string

Remarks

If not specified, the default namespace is used.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-argocd.html#cfn-eks-capability-argocd-namespace

NetworkAccess

Configuration for network access to the Argo CD capability's managed API server endpoint.

object? NetworkAccess { get; }

Property Value

object

Remarks

By default, the Argo CD server is accessible via a public endpoint. You can optionally specify one or more VPC endpoint IDs to enable private connectivity from your VPCs.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-argocd.html#cfn-eks-capability-argocd-networkaccess

Type union: either IResolvable or CfnCapability.INetworkAccessProperty

RbacRoleMappings

A list of role mappings that define which IAM Identity Center users or groups have which Argo CD roles.

object? RbacRoleMappings { get; }

Property Value

object

Remarks

Each mapping associates an Argo CD role (ADMIN, EDITOR, or VIEWER) with one or more IAM Identity Center identities.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-argocd.html#cfn-eks-capability-argocd-rbacrolemappings

Type union: either IResolvable or (either IResolvable or CfnCapability.IArgoCdRoleMappingProperty)[]

ServerUrl

The URL of the Argo CD server.

string? ServerUrl { get; }

Property Value

string

Remarks

Use this URL to access the Argo CD web interface and API.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-argocd.html#cfn-eks-capability-argocd-serverurl