Module: AWSCDK::IAM::IOidcProvider

Includes:
AWSCDK::IResource, AWSCDK::Interfaces::AWSIAM::IOIDCProviderRef
Included in:
OidcProviderNative
Defined in:
iam/i_oidc_provider.rb

Overview

Represents an IAM OpenID Connect provider.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'iam/i_oidc_provider.rb', line 108

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :oidc_provider_ref => { kind: :property, name: "oidcProviderRef", is_optional: false },
    :oidc_provider_arn => { kind: :property, name: "oidcProviderArn", is_optional: false },
    :oidc_provider_issuer => { kind: :property, name: "oidcProviderIssuer", is_optional: false },
    :open_id_connect_provider_arn => { kind: :property, name: "openIdConnectProviderArn", is_optional: false },
    :open_id_connect_provider_issuer => { kind: :property, name: "openIdConnectProviderIssuer", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
  }
end

Instance Method Details

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



103
104
105
106
 
# File 'iam/i_oidc_provider.rb', line 103

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



27
28
29
 
# File 'iam/i_oidc_provider.rb', line 27

def env()
  jsii_get_property("env")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'iam/i_oidc_provider.rb', line 12

def node()
  jsii_get_property("node")
end

#oidc_provider_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM OpenID Connect provider.

Returns:

  • (String) 


48
49
50
 
# File 'iam/i_oidc_provider.rb', line 48

def oidc_provider_arn()
  jsii_get_property("oidcProviderArn")
end

#oidc_provider_issuer ⇒ String

The issuer for OIDC Provider.

Returns:

  • (String) 


55
56
57
 
# File 'iam/i_oidc_provider.rb', line 55

def oidc_provider_issuer()
  jsii_get_property("oidcProviderIssuer")
end

#oidc_provider_ref ⇒ AWSCDK::Interfaces::AWSIAM::OIDCProviderReference

A reference to a OIDCProvider resource.

Returns:



41
42
43
 
# File 'iam/i_oidc_provider.rb', line 41

def oidc_provider_ref()
  jsii_get_property("oidcProviderRef")
end

#open_id_connect_provider_arn ⇒ String

Alias for oidcProviderArn to maintain backwards compatibility for constructs which accept iam.IOpenIdConnectProvider.

Use oidc_provider_arn instead. This property exists for backward compatibility with existing constructs as migrating between the 2 constructs (OpenIdConnectProvider and OidcProviderNative) is not reasonably feasible as it requires a manual step (cdk import) since the resource type is changing between OpenIdConnectProvider and OidcProviderNative.

Returns:

  • (String) 


64
65
66
 
# File 'iam/i_oidc_provider.rb', line 64

def open_id_connect_provider_arn()
  jsii_get_property("openIdConnectProviderArn")
end

#open_id_connect_provider_issuer ⇒ String

Alias for oidcProviderIssuer to maintain backwards compatibility for constructs which accept `iam.IOpenIdConnectProvider.

Use oidc_provider_issuer instead. This property exists for backward compatibility with existing constructs as migrating between the 2 constructs (OpenIdConnectProvider and OidcProviderNative) is not reasonably feasible as it requires a manual step (cdk import) since the resource type is changing between OpenIdConnectProvider and OidcProviderNative.

Returns:

  • (String) 


73
74
75
 
# File 'iam/i_oidc_provider.rb', line 73

def open_id_connect_provider_issuer()
  jsii_get_property("openIdConnectProviderIssuer")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



34
35
36
 
# File 'iam/i_oidc_provider.rb', line 34

def stack()
  jsii_get_property("stack")
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



84
85
86
87
88
89
 
# File 'iam/i_oidc_provider.rb', line 84

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end