@aws-quickstart/eks-blueprints
    Preparing search index...

    Class ArgoCapability

    ArgoCD capability for EKS clusters. Enables GitOps workflows and continuous deployment through ArgoCD integration. Requires AWS Identity Center for authentication and uses Secrets Manager for credential access.

    // Using props
    new ArgoCapability({
      idcInstanceArn: "arn:aws:sso:::instance/ssoins-123",
      roleMappings: { adminUsers: ["user-id-123"], viewerGroups: ["group-id-456"] },
    });

    // Using builder methods
    new ArgoCapability({ idcInstanceArn: "arn:aws:sso:::instance/ssoins-123" })
      .addAdmin("user-id-123", SsoIdentityType.SSO_USER)
      .addViewer("group-id-456", SsoIdentityType.SSO_GROUP);

    Hierarchy (View Summary)

    Index
    constructor
    DEFAULT_POLICY_NAME options props type defaultProps
    addAdmin addEditor addViewer create setupRole
    DEFAULT_POLICY_NAME: "AWSSecretsManagerClientReadOnlyAccess"

    Default AWS managed policy name for this capability type. Set to undefined in base class for security - subclasses should override.

    options: ArgoCapabilityProps
    props: CapabilityProps

    Configuration properties for the capability

    type: CapabilityType

    CapabilityType

    defaultProps: Partial<ArgoCapabilityProps> = ...

    • Sets up IAM role for the capability with appropriate policies. Creates managed policy references within stack context to avoid CDK v2.224.0+ issues.

      Parameters

      • clusterInfo: ClusterInfo

        Information about the target EKS cluster

      • capabilityType: CapabilityType

        Type of capability being created

      • OptionalpolicyName: string

        Optional custom managed policy name

      • OptionalpolicyDocument: PolicyDocument

        Optional inline policy document

      Returns string

      ARN of the created or configured IAM role

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods